From a502d96a860456ec5e8c96761db70f7cabb74751 Mon Sep 17 00:00:00 2001 From: Paul Martin <paul@paulsputer.com> Date: Sat, 30 Apr 2016 04:19:14 -0400 Subject: [PATCH] Merge pull request #1073 from gitblit/1062-DocEditorUpdates --- src/site/design.mkd | 38 +++++++++++++++++++++++--------------- 1 files changed, 23 insertions(+), 15 deletions(-) diff --git a/src/site/design.mkd b/src/site/design.mkd index 5ca8355..9ef302c 100644 --- a/src/site/design.mkd +++ b/src/site/design.mkd @@ -1,7 +1,7 @@ ## Design Principles 1. [Keep It Simple, Stupid](http://en.wikipedia.org/wiki/KISS_principle) 2. Offer useful features for serving Git repositories. If feature is complex, refer to #1. -3. All dependencies must be retrievable from a publicly accessible [Maven](http://maven.apache.org) repository.<br/>This is to ensure authenticity of dependencies and to automate the setup of developer environments. +3. All dependencies must be retrievable from a publicly accessible [Maven](http://maven.apache.org) repository.<br/>This is to ensure authenticity of dependencies and to automate the setup of developer environments. ## Architecture @@ -12,9 +12,13 @@ - [Bootstrap](http://twitter.github.com/bootstrap) (Apache 2.0) - [GLYPHICONS](http://glyphicons.com) (Creative Commons CC-BY) +- [Iconic](http://somerandomdude.com/work/iconic) (Creative Commons Share Alike 3.0) +- [AngularJS](http://angularjs.org) (MIT) - [Clippy](https://github.com/mojombo/clippy) (MIT) - [google-code-prettify](http://code.google.com/p/google-code-prettify) (Apache 2.0) - [Commons Daemon](http://commons.apache.org/daemon) (Apache 2.0) +- [jQuery](https://jquery.org) (MIT) +- [flotr2](http://humblesoftware.com/flotr2) (BSD) - magnifying glass search icon courtesy of [Gnome](http://gnome.org) (Creative Commons CC-BY) - Git logo originally designed by [Jason Long](http://git-scm.com/downloads/logos) - modified Git logo originally designed by [Henrik Nyh](http://henrik.nyh.se/2007/06/alternative-git-logo-and-favicon) @@ -26,12 +30,10 @@ - [JGit][jgit] (EDL 1.0) - [Wicket](http://wicket.apache.org) (Apache 2.0) -- [WicketStuff GoogleCharts](https://github.com/wicketstuff/core/wiki/GoogleCharts) (Apache 2.0) -- [MarkdownPapers](http://markdown.tautua.org) (Apache 2.0) - [Jetty](http://eclipse.org/jetty) (Apache 2.0, EPL 1.0) - [SLF4J](http://www.slf4j.org) (MIT/X11) -- [Log4j](http://logging.apache.org/log4j) (Apache 2.0) -- [JCommander](http://jcommander.org) (Apache 2.0) +- [Log4j](http://logging.apache.org/log4j) (Apache 2.0) +- [args4j](http://args4j.kohsuke.org) (Apache 2.0) - [BouncyCastle](http://www.bouncycastle.org) (MIT/X11) - [JSch - Java Secure Channel](http://www.jcraft.com/jsch) (BSD) - [Rome](http://rome.dev.java.net) (Apache 1.1) @@ -45,12 +47,21 @@ - [JCalendar](http://www.toedter.com/en/jcalendar) (LGPL 2.1) - [Commons-Compress](http://commons.apache.org/compress) (Apache 2.0) - [XZ for Java](http://tukaani.org/xz/java.html) (Public Domain) +- [FreeMarker](http://www.freemarker.org) (modified BSD) +- [Waffle](http://dblock.github.io/waffle) (EPL 1.0) +- [JNA](https://github.com/twall/jna) (LGPL 2.1) +- [Guava](https://code.google.com/p/guava-libraries) (Apache 2.0) +- [libpam4j](https://github.com/kohsuke/libpam4j) (MIT) +- [commons-codec](http://commons.apache.org/proper/commons-codec) (Apache 2.0) +- [pegdown](https://github.com/sirthias/pegdown) (Apache 2.0) +- [jedis](https://github.com/xetorthio/jedis) (MIT) +- [Mina SSHD](https://mina.apache.org) (Apache 2.0) +- [pf4j](https://github.com/decebals/pf4j) (Apache 2.0) +- [google-guice](https://code.google.com/p/google-guice) (Apache 2.0) ### Other Build Dependencies - [Fancybox image viewer](http://fancybox.net) (MIT and GPL dual-licensed) - [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) - [Moxie](http://moxie.gitblit.com) (Apache 2.0) ## Building from Source @@ -59,17 +70,14 @@ 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. +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. +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. +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. - - 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. +6. Execute the *com.gitblit.GitBlitServer* class to start Gitblit. ## Contributing @@ -81,4 +89,4 @@ [git]: http://git-scm.com "Official Git Site" [gitbltsrc]: http://github.com/gitblit "gitblit git repository" [googlecode]: http://code.google.com/p/gitblit "gitblit project management" -[apachelicense]: http://www.apache.org/licenses/LICENSE-2.0 "Apache License, Version 2.0" \ No newline at end of file +[apachelicense]: http://www.apache.org/licenses/LICENSE-2.0 "Apache License, Version 2.0" -- Gitblit v1.9.1