Author: gk
Date: Mon May 31 10:59:20 2021
New Revision: 1890339
URL: http://svn.apache.org/viewvc?rev=1890339&view=rev
Log:
- More readable README.md
- fix Fulcrum wrapper site
Modified:
turbine/fulcrum/trunk/README.md
turbine/fulcrum/trunk/site/pom.xml
turbine/fulcrum/trunk/site/src/site/site.xml
Modified: turbine/fulcrum/trunk/README.md
URL:
http://svn.apache.org/viewvc/turbine/fulcrum/trunk/README.md?rev=1890339&r1=1890338&r2=1890339&view=diff
==============================================================================
--- turbine/fulcrum/trunk/README.md (original)
+++ turbine/fulcrum/trunk/README.md Mon May 31 10:59:20 2021
@@ -1,31 +1,19 @@
---------------------------------------------------------------------------
- Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
---------------------------------------------------------------------------
-
-# F U L C R U M
+# [Apache F U L C R U M](https://turbine.apache.org/fulcrum/)
--------------------------------------------------------------------------
Fulcrum is a collection of components originally part of the Turbine core
project that are suitable for use in any environment. They are designed to
be used within any Avalon-compatible container.
+## U S A G E
+
+Apache Fulcrum components might be used standalone, e.g. Fulcrum Crypto, but
+most components work best in an environment which uses the Fulcrum Yaafi
service framework
+(which is using the Avalon service lifecycle interfaces aka Avalon container).
+
+You can find a web framework, which is powered by Fulcrum here: [Apache
Turbine](https://turbine.apache.org/).
-### B U I L D I N G
+## B U I L D I N G
--------------------------------------------------------------------------
You must have Maven 3.x
@@ -35,8 +23,8 @@ instructions on building. This document
https://maven.apache.org/guides/getting-started/
--------------------------------------------
-### GIT READONLY
+
+### GIT READONLY (may change)
-------------------------------------------
You could use git to checkout current trunk:
@@ -44,8 +32,26 @@ You could use git to checkout current tr
git clone https://github.com/apache/turbine-fulcrum.git
git checkout -b remote-trunk remotes/origin/trunk
+
+
+ ### SVN
+ --------------------------------------------------------------------------
+
+ Check it out with
+
+ svn co https://svn.apache.org/repos/asf/turbine/fulcrum/trunk fulcrum-trunk
+
+## Documentation
+--------------------------------------------------------------------------
+
+Each component has its section [here](https://turbine.apache.org/fulcrum/).
+## Requirements
--------------------------------------------------------------------------
+
+Fulcrum Components requires Java 8. Older components might require Java 7 only.
+
+ -----------------------------------------------------------------------
## COMPONENT DEVELOPMENT
--------------------------------------------------------------------------
### Publishing Workflow
@@ -212,3 +218,7 @@ Omit site:stage, which reqires site elem
mvn site scm-publish:publish-scm -Dscmpublish.dryRun=true
mvn clean site scm-publish:publish-scm -Dusername=<username>
-Dpassword=<pw>
+
+## License
+
+Apache Fulcrum is distributed under the [Apache License, version
2.0](http://www.apache.org/licenses/LICENSE-2.0.html).
Modified: turbine/fulcrum/trunk/site/pom.xml
URL:
http://svn.apache.org/viewvc/turbine/fulcrum/trunk/site/pom.xml?rev=1890339&r1=1890338&r2=1890339&view=diff
==============================================================================
--- turbine/fulcrum/trunk/site/pom.xml (original)
+++ turbine/fulcrum/trunk/site/pom.xml Mon May 31 10:59:20 2021
@@ -220,7 +220,6 @@
<plugin> <!-- Thanks to Apache Commons -->
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-scm-publish-plugin</artifactId>
- <version>1.1</version>
<configuration>
<content>${siteContent.path}</content>
<pubScmUrl>scm:svn:${turbine.scmPubUrl}</pubScmUrl>
@@ -282,7 +281,6 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-project-info-reports-plugin</artifactId>
- <version>3.1.1</version>
<reportSets>
<reportSet>
<reports>
Modified: turbine/fulcrum/trunk/site/src/site/site.xml
URL:
http://svn.apache.org/viewvc/turbine/fulcrum/trunk/site/src/site/site.xml?rev=1890339&r1=1890338&r2=1890339&view=diff
==============================================================================
--- turbine/fulcrum/trunk/site/src/site/site.xml (original)
+++ turbine/fulcrum/trunk/site/src/site/site.xml Mon May 31 10:59:20 2021
@@ -32,7 +32,7 @@
<skin>
<groupId>org.apache.maven.skins</groupId>
<artifactId>maven-fluido-skin</artifactId>
- <version>1.9</version>
+ <version>1.8</version>
</skin>
<body>
@@ -52,9 +52,8 @@
<item name="Crypto" href="/fulcrum-crypto/"/>
<item name="Factory" href="/fulcrum-factory/"/>
<item name="HsqlDB" href="/fulcrum-hsqldb/"/>
- <item name="Intake" href="/fulcrum-intake/"/>
- <item name="Jetty" href="/fulcrum-jetty/"/>
- <item name="JSON" href="/fulcrum-json/"/>
+ <item name="Intake" href="/fulcrum-intake/"/>
+ <item name="JSON" href="/fulcrum-json/"/>
<item name="Localization" href="/fulcrum-localization/"/>
<item name="Mimetype" href="/fulcrum-mimetype/"/>
<item name="Parser" href="/fulcrum-parser/"/>
@@ -67,7 +66,7 @@
<item name="Hibernate Impl"
href="/fulcrum-security/fulcrum-security-hibernate/"/>
<item name="Torque Impl"
href="/fulcrum-security/fulcrum-security-torque/"/>
</item>
- <item name="Spring" href="/fulcrum-spring/"/>
+ <item name="Spring" href="/fulcrum-spring/"/>
<item name="Test Container" href="/fulcrum-testcontainer/"/>
<item name="Upload" href="/fulcrum-upload/"/>
<item name="XSLT" href="/fulcrum-xslt/"/>
@@ -77,7 +76,6 @@
<menu name="Sandbox Components">
<item name="CommonsEmail" href="/fulcrum-commonsemail/"/>
- <item name="JSON" href="/fulcrum-json/"/>
<item name="ResourceManager" href="/fulcrum-resourcemanager/"/>
<item name="Script" href="/fulcrum-script/"/>
<item name="Template" href="/fulcrum-template/"/>
@@ -88,6 +86,7 @@
<item name="Configuration" href="/fulcrum-configuration-impl/"/>
<item name="DVSL" href="/fulcrum-dvsl/"/>
<item name="Groovy" href="/fulcrum-groovy/"/>
+ <item name="Jetty" href="/fulcrum-jetty/"/>
<item name="Naming" href="/fulcrum-naming/"/>
<item name="OSWorkflow" href="/sites/osworkflow.html"
collapse="true">
<item name="OSWorkflow" href="/fulcrum-osworkflow/"/>
