From 424fe1b372d225d65eb42e6125b24cbb982c5969 Mon Sep 17 00:00:00 2001 From: James Moger <james.moger@gitblit.com> Date: Wed, 01 Jun 2011 19:51:41 -0400 Subject: [PATCH] Stats -> Metrics. Docs in distribution zip. Created MetricUtils. --- docs/00_index.mkd | 13 ++++++++----- 1 files changed, 8 insertions(+), 5 deletions(-) diff --git a/docs/00_index.mkd b/docs/00_index.mkd index e21a158..0211be6 100644 --- a/docs/00_index.mkd +++ b/docs/00_index.mkd @@ -101,16 +101,16 @@ - [Log4j](http://logging.apache.org/log4j) (Apache 2.0) - [JCommander](http://jcommander.org) (Apache 2.0) - [BouncyCastle](http://www.bouncycastle.org) (MIT/X11) +- [JSch - Java Secure Channel](http://www.jcraft.com/jsch) (BSD) ### Other Build Dependencies - [Fancybox image viewer](http://fancybox.net) (MIT and GPL dual-licensed) -- [JSch - Java Secure Channel](http://www.jcraft.com/jsch) (BSD) - [JUnit](http://junit.org) (Common Public License) -## Building +## Building from Source [Eclipse](http://eclipse.org) is recommended for development as the project settings are preconfigured. -Additionally, [Google CodePro AnalytiX](http://code.google.com/javadevtools), [eclipse-cs](http://eclipse-cs.sourceforge.net), and [FindBugs](http://findbugs.sourceforge.net) are recommended development tools. +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/> @@ -118,8 +118,11 @@ 3. 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.* 4. Select your gitblit project root and **Refresh** the project, this should correct all build problems. -5. Review the settings in `gitblit.properties` in your project root.<br/> -Make sure you set an appropriate value for *git.repositoriesFolder*. +5. 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. 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/> + - 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. [jgit]: http://eclipse.org/jgit "Eclipse JGit Site" -- Gitblit v1.9.1