summaryrefslogtreecommitdiffstats
path: root/README.markdown
diff options
context:
space:
mode:
authorJames Moger <james.moger@gitblit.com>2014-06-03 10:18:25 -0400
committerJames Moger <james.moger@gitblit.com>2014-06-03 10:34:51 -0400
commitb79824366fe4814e6912fa38f6da7939b6f27124 (patch)
tree8f3edf5322c852ab9b85f62fbd5b7ff7b15c4399 /README.markdown
parent496532ac22430950a5e8973a7942a51bfd6b39e5 (diff)
downloadgitblit-b79824366fe4814e6912fa38f6da7939b6f27124.tar.gz
gitblit-b79824366fe4814e6912fa38f6da7939b6f27124.zip
Documentation
Diffstat (limited to 'README.markdown')
-rw-r--r--README.markdown13
1 files changed, 11 insertions, 2 deletions
diff --git a/README.markdown b/README.markdown
index 348afae4..76c15fce 100644
--- a/README.markdown
+++ b/README.markdown
@@ -4,7 +4,7 @@ Gitblit
Gitblit is an open source, pure Java Git solution for managing, viewing, and serving [Git](http://git-scm.com) repositories.
More information about Gitblit can be found [here](http://gitblit.com).
-[ ![Download](https://api.bintray.com/packages/gitblit/releases/stable/images/download.png) ](https://bintray.com/gitblit/releases/stable/_latestVersion)
+<a href='https://bintray.com/gitblit/releases/gitblit/_latestVersion'><img src='https://api.bintray.com/packages/gitblit/releases/gitblit/images/download.png'></a>
License
-------
@@ -12,6 +12,11 @@ License
Gitblit is distributed under the terms of the [Apache Software Foundation license, version 2.0](http://www.apache.org/licenses/LICENSE-2.0).
The text of the license is included in the file LICENSE in the root of the project.
+Contributing
+------------
+
+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).
+
Java Runtime Requirement
------------------------------------
@@ -25,6 +30,10 @@ Issues, binaries, & sources @ [Google Code](http://code.google.com/p/gitblit)
Building Gitblit
----------------
+
+Gitblit uses submodules.
+Make sure to clone using `--recursive` OR to execute `git submodule update --init --recursive`.
+
[Eclipse](http://eclipse.org) is recommended for development as the project settings are preconfigured.
1. Import the gitblit project into your Eclipse workspace.
@@ -39,4 +48,4 @@ Building Gitblit
Building Tips & Tricks
----------------------
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>
-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. \ No newline at end of file
+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.