James Moger
2014-06-10 52ae7c2a89cfa6db9096eed76a484c820a612fcc
commit | author | age
f13c4c 1 Gitblit
JM 2 =================
3
6c4be1 4 Gitblit is an open source, pure Java Git solution for managing, viewing, and serving [Git](http://git-scm.com) repositories.
1f9dae 5 More information about Gitblit can be found [here](http://gitblit.com).
f13c4c 6
b79824 7 <a href='https://bintray.com/gitblit/releases/gitblit/_latestVersion'><img src='https://api.bintray.com/packages/gitblit/releases/gitblit/images/download.png'></a>
69eeaa 8
f13c4c 9 License
JM 10 -------
11
6c4be1 12 Gitblit is distributed under the terms of the [Apache Software Foundation license, version 2.0](http://www.apache.org/licenses/LICENSE-2.0).
233eb0 13 The text of the license is included in the file LICENSE in the root of the project.
b79824 14
JM 15 Contributing
16 ------------
17
18 GitHub pull requests are preferred.  Any contributions must be distributed under the terms of the [Apache Software Foundation license, version 2.0](http://www.apache.org/licenses/LICENSE-2.0).
f13c4c 19
85c2e6 20 Java Runtime Requirement
f13c4c 21 ------------------------------------
JM 22
cff7cc 23 Gitblit requires at Java 7 Runtime Environment (JRE) or a Java 7 Development Kit (JDK).
f13c4c 24
JM 25 Getting help
26 ------------
27
6c4be1 28 Read the online documentation available at the [Gitblit website](http://gitblit.com)
233eb0 29 Issues, binaries, & sources @ [Google Code](http://code.google.com/p/gitblit)
f13c4c 30
JM 31 Building Gitblit
32 ----------------
b79824 33
JM 34 Gitblit uses submodules.
35 Make sure to clone using `--recursive` OR to execute `git submodule update --init --recursive`.
36
f13c4c 37 [Eclipse](http://eclipse.org) is recommended for development as the project settings are preconfigured.
JM 38
6c4be1 39 1. Import the gitblit project into your Eclipse workspace.
f13c4c 40 *There will be lots of build errors.*
6c4be1 41 2. Using Ant, execute the `build.xml` script in the project root.
f13c4c 42 *This will download all necessary build dependencies and will also generate the Keys class for accessing settings.*
JM 43 3. Select your gitblit project root and **Refresh** the project, this should correct all build problems.
6c4be1 44 4. Using JUnit, execute the `com.gitblit.tests.GitBlitSuite` test suite.
1f9dae 45 *This will clone some repositories from the web and run through the unit tests.*
ea2c2a 46 5. Execute the *com.gitblit.GitBlitServer* class to start Gitblit GO.
JM 47
48 Building Tips & Tricks
49 ----------------------
6c4be1 50 1. If you are running Ant from an ANSI-capable console, consider setting the `MX_COLOR` environment variable before executing Ant.<pre>set MX_COLOR=true</pre>
b79824 51 2. The build script will honor your Maven proxy settings.  If you need to fine-tune this, please review the [settings.moxie](http://gitblit.github.io/moxie/settings.html) documentation.