From f08c1ca55e1ffaef81f3d6514aa4bffa5d716c5b Mon Sep 17 00:00:00 2001 From: James Moger <james.moger@gitblit.com> Date: Sun, 05 Jun 2011 15:21:12 -0400 Subject: [PATCH] Added git-notes to docs. Fixed parent path mode. --- docs/00_index.mkd | 22 +++++++++++----------- 1 files changed, 11 insertions(+), 11 deletions(-) diff --git a/docs/00_index.mkd b/docs/00_index.mkd index e21a158..0902733 100644 --- a/docs/00_index.mkd +++ b/docs/00_index.mkd @@ -30,6 +30,7 @@ - Administrators may create, edit, rename, or delete users through the web UI - Repository Owners may edit repositories through the web UI - Automatically generates a self-signed certificate for https communications +- Git-notes support - Dates can optionally be displayed using the browser's reported timezone - Author and Committer email address display can be controlled - Dynamic zip downloads feature @@ -52,13 +53,10 @@ - Gitblit is an integrated, full-stack solution. There is no WAR build at this time. ### Todo List -- Review spots where Gitblit can cache data instead of abusing the disk - - stats - - users.properties access - - available repositories - - etc - Code documentation - Unit testing +- Branch selector on Metrics +- Blame ### Idea List - Ticgit activity/timeline @@ -67,7 +65,6 @@ - View images on Blob page - View other binary files on Blob page - Markdown editing feature -- Blame (waiting for the [JGit][jgit] team to do the hard part) ### License Licensed under the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0) @@ -101,16 +98,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 +115,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