From 2029f020a3227230c49747421b00c03744d6c8b4 Mon Sep 17 00:00:00 2001 From: Lars Jung Date: Sat, 13 Oct 2012 15:23:30 +0200 Subject: [PATCH] Updates readme. --- README.md | 55 ++++++++++++++++++++++++++++++++----------------------- 1 file changed, 32 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index 5ef8dec7..d1360024 100644 --- a/README.md +++ b/README.md @@ -1,30 +1,18 @@ # h5ai +a modern HTTP web server index for Apache httpd, lighttpd, nginx and Cherokee -Please don't use files from the `src` folder for installation. -They need to be preprocessed to work correctly. You'll find a preprocessed -package on the [project page](http://larsjung.de/h5ai/). +The preferred way to report a bug or make a feature request is to +create [a new issue](http://github.com/lrsjng/h5ai/issues/new) on GitHub! -* to report a bug or make a feature request please create [a new issue](http://github.com/lrsjng/h5ai/issues/new) on GitHub -* website with download, docs and demo: -* sources: -**h5ai** is provided under the terms of the [MIT License](http://github.com/lrsjng/h5ai/blob/develop/LICENSE.md). -It profits from these great projects: -[AmplifyJS](http://amplifyjs.com) (MIT/GPL), -[Faenza icon set](http://tiheum.deviantart.com/art/Faenza-Icons-173323228) (GPL), -[HTML5 ★ Boilerplate](http://html5boilerplate.com) (MIT), -[jQuery](http://jquery.com) (MIT), -[jQuery.fracs](http://larsjung.de/fracs/) (MIT), -[jQuery.mousewheel](http://github.com/brandonaaron/jquery-mousewheel) (MIT), -[jQuery.qrcode](http://larsjung.de/qrcode/) (MIT), -[jQuery.scrollpanel](http://larsjung.de/scrollpanel/) (MIT), -[markdown-js](http://github.com/evilstreak/markdown-js) (MIT), -[Modernizr](http://www.modernizr.com) (MIT/BSD), -[modulejs](http://larsjung.de/modulejs/) (MIT), -[Moment.js](http://momentjs.com) (MIT), -[spin.js](http://fgnass.github.com/spin.js/) (MIT), -[SyntaxHighlighter](http://alexgorbatchev.com/SyntaxHighlighter/) (MIT/GPL), -[Underscore.js](http://underscorejs.org) (MIT) +## Install + +**Note:** please don't use files from the `src` folder for installation. +They need to be preprocessed to work correctly. + +You'll find a preprocessed package, as well as detailed installation +instructions on the [project page](http://larsjung.de/h5ai/). + ## Build @@ -50,6 +38,27 @@ To create an fresh zipball run > makejs release +## License + +**h5ai** is provided under the terms of the [MIT License](http://github.com/lrsjng/h5ai/blob/develop/LICENSE.md). +It profits from these great projects: +[AmplifyJS](http://amplifyjs.com) (MIT/GPL), +[Faenza icon set](http://tiheum.deviantart.com/art/Faenza-Icons-173323228) (GPL), +[HTML5 ★ Boilerplate](http://html5boilerplate.com) (MIT), +[jQuery](http://jquery.com) (MIT), +[jQuery.fracs](http://larsjung.de/fracs/) (MIT), +[jQuery.mousewheel](http://github.com/brandonaaron/jquery-mousewheel) (MIT), +[jQuery.qrcode](http://larsjung.de/qrcode/) (MIT), +[jQuery.scrollpanel](http://larsjung.de/scrollpanel/) (MIT), +[markdown-js](http://github.com/evilstreak/markdown-js) (MIT), +[Modernizr](http://www.modernizr.com) (MIT/BSD), +[modulejs](http://larsjung.de/modulejs/) (MIT), +[Moment.js](http://momentjs.com) (MIT), +[spin.js](http://fgnass.github.com/spin.js/) (MIT), +[SyntaxHighlighter](http://alexgorbatchev.com/SyntaxHighlighter/) (MIT/GPL), +[Underscore.js](http://underscorejs.org) (MIT) + + ## Changelog (**h5ai** uses [semantic versioning](http://semver.org/))