2011-07-29 03:25:48 +02:00
|
|
|
# h5ai
|
2014-07-29 22:16:15 +02:00
|
|
|
|
2014-08-15 17:20:20 +02:00
|
|
|
[![license][license-img]][gh] [![web][web-img]][web] [![github][gh-img]][gh]
|
2014-07-29 22:16:15 +02:00
|
|
|
|
|
|
|
|
A modern HTTP web server index for Apache httpd, lighttpd, nginx and Cherokee.
|
2014-08-03 20:49:46 +02:00
|
|
|
For bug reports and feature requests please use [issues][gh-issues].
|
2011-11-26 20:53:51 +01:00
|
|
|
|
2011-07-29 03:25:48 +02:00
|
|
|
|
2012-10-13 15:23:30 +02:00
|
|
|
## Install
|
2014-08-07 00:08:41 +02:00
|
|
|
|
|
|
|
|
Do **not** install any files from the `src` folder, they need to be
|
|
|
|
|
preprocessed to work correctly! Find a preprocessed package and detailed
|
|
|
|
|
install instructions on the [project page][web].
|
2012-10-13 15:23:30 +02:00
|
|
|
|
2011-06-16 01:24:49 +02:00
|
|
|
|
2012-08-05 17:39:33 +02:00
|
|
|
## Build
|
2014-08-07 00:08:41 +02:00
|
|
|
|
|
|
|
|
There are installation ready packages for the latest [releases][release] and
|
2014-08-12 00:37:38 +02:00
|
|
|
[dev builds][develop]. But if you want to build **h5ai** yourself you need to
|
|
|
|
|
install the build tool [fQuery][fquery] first:
|
2012-08-05 17:39:33 +02:00
|
|
|
|
2014-07-27 16:49:41 +02:00
|
|
|
> npm install -g fquery@0.11.0
|
2012-08-05 17:39:33 +02:00
|
|
|
|
2014-08-07 00:20:56 +02:00
|
|
|
This will globally install fQuery and its command line tool `makejs`. Run
|
|
|
|
|
`makejs --help` to see if everything worked fine. To clone and build the
|
|
|
|
|
project run the following commands, this will create a new folder `build`
|
|
|
|
|
including a fresh zipball.
|
2012-09-18 16:46:48 +02:00
|
|
|
|
|
|
|
|
> git clone git://github.com/lrsjng/h5ai.git
|
|
|
|
|
> cd h5ai
|
2012-09-18 16:59:11 +02:00
|
|
|
> makejs release
|
2012-08-05 17:39:33 +02:00
|
|
|
|
2011-11-01 22:33:00 +01:00
|
|
|
|
2012-10-13 15:23:30 +02:00
|
|
|
## License
|
2014-08-07 00:08:41 +02:00
|
|
|
|
2014-07-27 16:49:41 +02:00
|
|
|
The MIT License (MIT)
|
|
|
|
|
|
|
|
|
|
Copyright (c) 2014 Lars Jung (http://larsjung.de)
|
|
|
|
|
|
|
|
|
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
|
|
|
of this software and associated documentation files (the "Software"), to deal
|
|
|
|
|
in the Software without restriction, including without limitation the rights
|
|
|
|
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
|
|
|
copies of the Software, and to permit persons to whom the Software is
|
|
|
|
|
furnished to do so, subject to the following conditions:
|
|
|
|
|
|
|
|
|
|
The above copyright notice and this permission notice shall be included in
|
|
|
|
|
all copies or substantial portions of the Software.
|
|
|
|
|
|
|
|
|
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
|
|
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
|
|
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
|
|
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
|
|
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
|
|
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
|
|
|
THE SOFTWARE.
|
2012-10-13 15:23:30 +02:00
|
|
|
|
2012-10-13 15:26:44 +02:00
|
|
|
|
2014-07-27 16:49:41 +02:00
|
|
|
## References
|
2014-08-07 00:08:41 +02:00
|
|
|
|
2014-08-03 02:04:05 +02:00
|
|
|
**h5ai** profits from these great projects:
|
2014-08-10 21:15:45 +02:00
|
|
|
[GNOME Symbolic Icons](https://github.com/GNOME/gnome-icon-theme-symbolic) (CC BY-SA 3.0),
|
2014-08-03 02:03:06 +02:00
|
|
|
[HTML5 ★ Boilerplate](http://html5boilerplate.com) (MIT),
|
2014-05-29 17:38:31 +02:00
|
|
|
[jQuery](http://jquery.com) (MIT),
|
2012-10-13 15:23:30 +02:00
|
|
|
[jQuery.fracs](http://larsjung.de/fracs/) (MIT),
|
2013-09-04 15:57:48 +02:00
|
|
|
[jQuery.mousewheel](https://github.com/brandonaaron/jquery-mousewheel) (MIT),
|
2012-10-13 15:23:30 +02:00
|
|
|
[jQuery.qrcode](http://larsjung.de/qrcode/) (MIT),
|
|
|
|
|
[jQuery.scrollpanel](http://larsjung.de/scrollpanel/) (MIT),
|
2014-08-04 02:32:41 +02:00
|
|
|
[Lo-Dash](http://lodash.com) (MIT),
|
2014-08-03 21:12:40 +02:00
|
|
|
[marked](https://github.com/chjj/marked) (MIT),
|
2012-10-13 15:23:30 +02:00
|
|
|
[Modernizr](http://www.modernizr.com) (MIT/BSD),
|
|
|
|
|
[modulejs](http://larsjung.de/modulejs/) (MIT),
|
|
|
|
|
[Moment.js](http://momentjs.com) (MIT),
|
2014-08-04 17:06:39 +02:00
|
|
|
[Prism](http://prismjs.com) (MIT)
|
2014-08-03 20:49:46 +02:00
|
|
|
|
|
|
|
|
|
|
|
|
|
[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/
|
2014-08-12 00:37:38 +02:00
|
|
|
[develop]: http://release.larsjung.de/h5ai/develop/
|
2014-08-03 20:49:46 +02:00
|
|
|
[fquery]: http://larsjung.de/fquery/
|
|
|
|
|
|
2014-08-15 17:04:05 +02:00
|
|
|
[license-img]: http://img.shields.io/badge/license-MIT-a0a060.svg?style=flat-square
|
|
|
|
|
[web-img]: http://img.shields.io/badge/web-larsjung.de/h5ai-a0a060.svg?style=flat-square
|
2014-08-15 17:20:20 +02:00
|
|
|
[gh-img]: http://img.shields.io/badge/github-lrsjng/h5ai-a0a060.svg?style=flat-square
|
