mirror/php-h5ai
1
0
Fork 0
mirror of https://github.com/lrsjng/h5ai.git synced 2025-08-14 01:44:06 +02:00
Code Issues Releases Wiki Activity

Update readme.

Browse Source
This commit is contained in:
Lars Jung
2014-07-27 16:49:41 +02:00
parent 49603c6f80
commit 551da05c6c
5 changed files with 27 additions and 201 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
README.md
View File

@@ -5,7 +5,6 @@ create [a new issue](https://github.com/lrsjng/h5ai/issues/new) on GitHub!
## 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
@@ -13,11 +12,10 @@ instructions on the [project page](http://larsjung.de/h5ai/).
## Build
There are repositories for the latest [releases](http://release.larsjung.de/h5ai/) and [dev builds](http://release.larsjung.de/h5ai/dev/).
But if you want to build **h5ai** yourself you need to install the build tool [fQuery](http://larsjung.de/fquery/) first:
> npm install -g fquery
> npm install -g fquery@0.11.0
This will 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.
@@ -29,10 +27,31 @@ You'll find a new directory `build` including a fresh zipball.
## License
The MIT License (MIT)
**h5ai** is provided under the terms of the [MIT License](https://github.com/lrsjng/h5ai/blob/develop/LICENSE.md).
Copyright (c) 2014 Lars Jung (http://larsjung.de)
It profits from these great projects:
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.
## References
**h5ai** profits from these great projects:
[Evolvere Icon Theme](http://franksouza183.deviantart.com/art/Evolvere-Icon-theme-440718295) (CC BY-NC-ND 3.0),
[Faenza Icons](http://tiheum.deviantart.com/art/Faenza-Icons-173323228) (GPL),
[Gnome Symbolic Icon Theme](https://git.gnome.org/browse/gnome-icon-theme-symbolic/) (CC BY-SA 3.0),