From 2c92d5e415f95e8e9c43df88f93c14aced677e30 Mon Sep 17 00:00:00 2001 From: James Moger <james.moger@gitblit.com> Date: Sat, 14 Jun 2014 09:44:48 -0400 Subject: [PATCH] Documentation --- README.markdown | 13 +++++++++++-- 1 files changed, 11 insertions(+), 2 deletions(-) diff --git a/README.markdown b/README.markdown index 348afae..76c15fc 100644 --- a/README.markdown +++ b/README.markdown @@ -4,13 +4,18 @@ 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). -[  ](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 ------- 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 @@ 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 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. -- Gitblit v1.9.1