| <?xml version="1.0"?> |
| <!-- |
| 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. |
| --> |
| |
| <document> |
| |
| <properties> |
| <title>Download and Building Fulcrum</title> |
| <!-- author email="pete@kazmier.com">Pete Kazmier</author> |
| <author email="quintonm@bellsouth.net">Quinton McCombs</author> |
| <author email="epugh@upstate.com">Eric Pugh</author --> |
| </properties> |
| |
| <body> |
| |
| <section name="Binary And Source Distributions"> |
| <p> |
| If you already know how to use Fulcrum and simply want the latest |
| binaries or source, you can get them from the |
| <a target="_blank" href="http://www.apache.org/dyn/closer.cgi/turbine/fulcrum">Apache Mirror System</a>. |
| </p> |
| </section> |
| |
| <section name="Building all Fulcrum components"> |
| <p> |
| Building Fulcrum from GIT is very easy because it has been |
| Maven-enabled. |
| |
| To get all Fulcrum dependencies you may find it conveniet to get all of them in one repo. |
| |
| Therefore you would begin with <code>turbine-fulcrum-build</code> GIT repository (if you are |
| not familiar with the Apache GIT repositories, please refer to |
| the <a href="https://infra.apache.org/version-control.html">documentation</a>). |
| |
| <source> |
| git clone --recurse-submodules https://github.com/apache/turbine-fulcrum-build.git </source> |
| |
| You get all current Fulcrum components (thanks to git submodules) in one repo! |
| |
| Of course each fulcrum component has it's own repository. Find them in .gitmodules and select, what you want. |
| eihter using the gitbos repo URLs or the github repo |
| <source> |
| git clone https://gitbox.apache.org/repos/asf/turbine-fulcrum-parser.git |
| // equivalent |
| git clone https://github.com/apache/turbine-fulcrum-parser.git </source> |
| |
| </p> |
| <h4>Maven 3 Build</h4> |
| <p> |
| Please refer to the Maven 3 <a |
| href="http://maven.apache.org/guides/getting-started/">Getting |
| Started</a> document for instructions on how to install and |
| use Maven. |
| </p> |
| <p> |
| From the root directory of the Fulcrum project (where you checked |
| out the code to or unpacked a source distribution), simply run |
| <source> |
| mvn install </source> |
| This will start a process that will |
| build each component. After the component is built, it will be |
| installed into you local maven repository. |
| </p> |
| <p> |
| To build a local copy of the documentation, use this: |
| <source> |
| mvn site </source> |
| This will build a local copy of the web site in the 'target/site' directory. |
| Note, this uses a LOT of memory. If you can't build all of them, build them individually. |
| </p> |
| <subsection name="Current Build Issues"> |
| <p> |
| Depending on your version of Maven, you may have various problems with |
| the reports being generated, or you may run out of memory when you do a |
| complete build. One approach to take is to turn off running unit tests |
| <source><![CDATA[ |
| $ mvn site -DskipTests=true |
| ]]></source> |
| and/or excluding various components: |
| </p> |
| <source><![CDATA[ |
| $ mvn -pl parser,crypto site |
| ]]></source> |
| </subsection> |
| </section> |
| </body> |
| </document> |
| |
