diff options
| author | James Moger <james.moger@gitblit.com> | 2011-07-27 09:40:57 -0400 |
|---|---|---|
| committer | James Moger <james.moger@gitblit.com> | 2011-07-27 09:40:57 -0400 |
| commit | f8dc86f1b362c2906ea302eb56928b59156cd484 (patch) | |
| tree | 1ee069ffdaf4b8746af5c24b7b21cdecb25d36f1 /README.markdown | |
| parent | 6bbe04e963e9533f5e65413930efb6323ecd9eb7 (diff) | |
| download | gitblit-f8dc86f1b362c2906ea302eb56928b59156cd484.tar.gz gitblit-f8dc86f1b362c2906ea302eb56928b59156cd484.zip | |
Renamed README for GutHub.
Diffstat (limited to 'README.markdown')
| -rw-r--r-- | README.markdown | 33 |
1 files changed, 33 insertions, 0 deletions
diff --git a/README.markdown b/README.markdown new file mode 100644 index 00000000..a588cb44 --- /dev/null +++ b/README.markdown @@ -0,0 +1,33 @@ +Gitblit
+=================
+
+Gitblit is an open source, pure Java Git solution for managing, viewing, and serving [Git](http://git-scm.com) repositories.<br/>
+More information about Gitblit can be found [here](http://gitblit.com).
+
+License
+-------
+
+Gitblit is distributed under the terms of the Apache Software Foundation license, version 2.0. The text of the license is included in the file LICENSE in the root of the project.
+
+Java Runtime Requirement
+------------------------------------
+
+Gitblit requires at Java 6 Runtime Environment (JRE) or a Java 6 Development Kit (JDK).
+
+Getting help
+------------
+
+Read the online documentation available at the [Gitblit website](http://gitblit.com)
+
+Building Gitblit
+----------------
+[Eclipse](http://eclipse.org) is recommended for development as the project settings are preconfigured.
+
+1. Import the gitblit project into your Eclipse workspace.<br/>
+*There will be lots of build errors.*
+2. Using Ant, execute the `build.xml` script in the project root.<br/>
+*This will download all necessary build dependencies and will also generate the Keys class for accessing settings.*
+3. Select your gitblit project root and **Refresh** the project, this should correct all build problems.
+4. Using JUnit, execute the `com.gitblit.tests.GitBlitSuite` test suite.<br/>
+*This will clone some repositories from the web and run through the unit tests.*
+5. Execute the *com.gitblit.Launcher* class to start Gitblit.
\ No newline at end of file |