From 716745e2dd9b3925b1229433e7072580206f731e Mon Sep 17 00:00:00 2001
From: James Moger <james.moger@gitblit.com>
Date: Wed, 08 Jun 2011 17:38:11 -0400
Subject: [PATCH] Stubbed out Blame. Added Github banner to site. Documentation.
---
docs/00_index.mkd | 56 ++++++++++++++++++++++++++++++++++++++------------------
1 files changed, 38 insertions(+), 18 deletions(-)
diff --git a/docs/00_index.mkd b/docs/00_index.mkd
index e21a158..2f15b38 100644
--- a/docs/00_index.mkd
+++ b/docs/00_index.mkd
@@ -30,8 +30,12 @@
- 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
+- Branch metrics
+- Blame annotations view
- Dates can optionally be displayed using the browser's reported timezone
- Author and Committer email address display can be controlled
+- Search commit messages, authors, and committers
- Dynamic zip downloads feature
- Markdown view support
- Syntax highlighting
@@ -46,31 +50,37 @@
</ul>
### Limitations
+- [%JGIT%][jgit] does not [garbage collect or repack](http://www.kernel.org/pub/software/scm/git/docs/git-gc.html)
- HTTP/HTTPS are the only supported protocols
- Access controls are not path-based, they are repository-based
- Only Administrators can create, rename or delete repositories
- Gitblit is an integrated, full-stack solution. There is no WAR build at this time.
+### Caveats
+- I don't know everything there is to know about [Git][git] nor [JGit][jgit].
+- Gitblit may eat your data. Use at your own risk.
+- Gitblit may have security holes. Patches welcome. :)
+
### 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
+- Finish Blame (waiting for JGit 1.0.0 release)
+- Clone remote repository
### Idea List
-- Ticgit activity/timeline
-- Ticgit query feature with paging support
-- Ticgit ticket change history
-- View images on Blob page
-- View other binary files on Blob page
+- Consider [Apache Shiro](http://shiro.apache.org) for authentication
+- Stronger Ticgit read-only integration
+ - activity/timeline
+ - query feature with paging support
+ - change history
+- Ticgit write integration
+- Blob page improvements
+ - view images
+ - view other binary files (pdf, doc, etc)
- 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)
+Gitblit is distributed under the terms of the [Apache Software Foundation license, version 2.0][apachelicense]
### Inspirations
- [Gitweb](http://www.git-scm.com)
@@ -101,16 +111,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,10 +128,20 @@
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.
+
+
+## Contributing
+Patches welcome in any form.
+
+Contributions must be your own original work and must licensed under the [Apache License, Version 2.0][apachelicense], the same license used by Gitblit.
[jgit]: http://eclipse.org/jgit "Eclipse JGit Site"
[git]: http://git-scm.com "Official Git Site"
-[gitbltsrc]: http://somewhere.com "gitblit git repository"
\ No newline at end of file
+[gitbltsrc]: http://somewhere.com "gitblit git repository"
+[apachelicense]: http://www.apache.org/licenses/LICENSE-2.0 "Apache License, Version 2.0"
\ No newline at end of file
--
Gitblit v1.9.1