mirrors/h5ai
1
0
Fork 0
mirror of https://github.com/lrsjng/h5ai.git synced 2024-09-19 20:28:47 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update readme.

Browse source
This commit is contained in:
Lars Jung 2014-08-03 20:49:46 +02:00
parent ac5c914077
commit 114c63cfd7
1 changed files with 16 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
README.md
View file

@ -1,20 +1,19 @@
# h5ai # h5ai
[![web](http://img.shields.io/badge/web-larsjung.de/h5ai-a0a060.svg?style=flat)](http://larsjung.de/h5ai/) [![web][web-img]][web] [![GitHub][gh-img]][gh]
[![GitHub](http://img.shields.io/badge/GitHub-lrsjng/h5ai-a0a060.svg?style=flat)](https://github.com/lrsjng/h5ai)
A modern HTTP web server index for Apache httpd, lighttpd, nginx and Cherokee. A modern HTTP web server index for Apache httpd, lighttpd, nginx and Cherokee.
For bug reports and feature requests please use [issues](https://github.com/lrsjng/h5ai/issues). For bug reports and feature requests please use [issues][gh-issues].
## Install ## Install
Do **not** install any files from the `src` folder, they need to be preprocessed to work correctly! Do **not** install any files from the `src` folder, they need to be preprocessed to work correctly!
You'll find a preprocessed package, as well as detailed install instructions on the [project page](http://larsjung.de/h5ai/). You'll find a preprocessed package, as well as detailed install instructions on the [project page][web].
## Build ## Build
There are installation ready packages for the latest [releases](http://release.larsjung.de/h5ai/) and [dev builds](http://release.larsjung.de/h5ai/dev/). There are installation ready packages for the latest [releases][release] and [dev builds][release-dev].
But if you want to build **h5ai** yourself you need to install the build tool [fQuery](http://larsjung.de/fquery/) first: But if you want to build **h5ai** yourself you need to install the build tool [fQuery][fquery] first:
> npm install -g fquery@0.11.0 > npm install -g fquery@0.11.0
@ -66,3 +65,14 @@ THE SOFTWARE.
[Moment.js](http://momentjs.com) (MIT), [Moment.js](http://momentjs.com) (MIT),
[SyntaxHighlighter](http://alexgorbatchev.com/SyntaxHighlighter/) (MIT/GPL), [SyntaxHighlighter](http://alexgorbatchev.com/SyntaxHighlighter/) (MIT/GPL),
[Underscore.js](http://underscorejs.org) (MIT) [Underscore.js](http://underscorejs.org) (MIT)
[web]: http://larsjung.de/h5ai/
[gh]: https://github.com/lrsjng/h5ai
[gh-issues]: https://github.com/lrsjng/h5ai/issues
[release]: http://release.larsjung.de/h5ai/
[release-dev]: http://release.larsjung.de/h5ai/dev/
[fquery]: http://larsjung.de/fquery/
[web-img]: http://img.shields.io/badge/web-larsjung.de/h5ai-a0a060.svg?style=flat
[gh-img]: http://img.shields.io/badge/GitHub-lrsjng/h5ai-a0a060.svg?style=flat