From c05535c2a7e833c5e831e3774b4440d6459918dd Mon Sep 17 00:00:00 2001 From: James Moger <james.moger@gitblit.com> Date: Wed, 26 Oct 2011 17:07:11 -0400 Subject: [PATCH] Documentation. --- docs/04_design.mkd | 10 ++++++---- 1 files changed, 6 insertions(+), 4 deletions(-) diff --git a/docs/04_design.mkd b/docs/04_design.mkd index 70cea7c..921bc8b 100644 --- a/docs/04_design.mkd +++ b/docs/04_design.mkd @@ -10,6 +10,7 @@ ### Bundled Dependencies The following dependencies are bundled with Gitblit. +- [Bootstrap](http://twitter.github.com/bootstrap) (Apache 2.0) - [google-code-prettify](http://code.google.com/p/google-code-prettify) (Apache 2.0) - [Commons Daemon](http://commons.apache.org/daemon) (Apache 2.0) - magnifying glass search icon courtesy of [Gnome](http://gnome.org) (Creative Commons CC-BY) @@ -39,6 +40,7 @@ - [JUnit](http://junit.org) (Common Public License) - [commons-net](http://commons.apache.org/net) (Apache 2.0) - [ant-googlecode](http://code.google.com/p/ant-googlecode) (New BSD) +- [GenJar](http://genjar.sourceforge.net) (Apache 1.1) ## Building from Source [Eclipse](http://eclipse.org) is recommended for development as the project settings are preconfigured. @@ -46,15 +48,15 @@ Additionally, [Google CodePro AnalytiX](http://code.google.com/javadevtools), [eclipse-cs](http://eclipse-cs.sourceforge.net), [FindBugs](http://findbugs.sourceforge.net), and [EclEmma](http://www.eclemma.org) are recommended development tools. 1. Clone the git repository from [Github][gitbltsrc]. -2. Import the gitblit project into your Eclipse workspace.<br/> +2. Import the gitblit project into your Eclipse workspace. *There will be lots of build errors.* -3. Using Ant, execute the `build.xml` script in the project root.<br/> +3. Using Ant, execute the `build.xml` script in the project root. *This will download all necessary build dependencies and will also generate the Keys class for accessing settings.* 4. Select your gitblit project root and **Refresh** the project, this should correct all build problems. -5. Using JUnit, execute the `com.gitblit.tests.GitBlitSuite` test suite.<br/> +5. Using JUnit, execute the `com.gitblit.tests.GitBlitSuite` test suite. *This will clone some repositories from the web and run through the unit tests.* 5. Review the settings in `gitblit.properties` in your project root. - - By default, the *git.repositoriesFolder* points to the repositories cloned by the test suite.<br/> + - By default, the *git.repositoriesFolder* points to the repositories cloned by the test suite. - If running on Linux you may have to change the served port(s) to > 1024 unless you are developing as the root user. 6. Execute the *com.gitblit.Launcher* class to start Gitblit. -- Gitblit v1.9.1