mirror of
https://github.com/lrsjng/h5ai.git
synced 2024-09-19 20:28:47 -04:00
Update readme.
This commit is contained in:
parent
98b2a2af09
commit
1cdefa8492
1 changed files with 14 additions and 7 deletions
21
README.md
21
README.md
|
@ -7,19 +7,24 @@ 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!
|
|
||||||
You'll find a preprocessed package, as well as detailed install instructions on the [project page][web].
|
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].
|
||||||
|
|
||||||
|
|
||||||
## Build
|
## Build
|
||||||
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][fquery] first:
|
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][fquery] first:
|
||||||
|
|
||||||
> npm install -g fquery@0.11.0
|
> npm install -g fquery@0.11.0
|
||||||
|
|
||||||
This will install fQuery and its command line tool `makejs`. Run `makejs --help` to see if everything
|
This will install *fQuery* and its command line tool `makejs`. Run `makejs --help`
|
||||||
worked fine. To clone and build the project run the following commands.
|
to see if everything worked fine. To clone and build the project run
|
||||||
You'll find a new directory `build` including a fresh zipball.
|
the following commands, this will create a new folder `build` including a
|
||||||
|
fresh zipball.
|
||||||
|
|
||||||
> git clone git://github.com/lrsjng/h5ai.git
|
> git clone git://github.com/lrsjng/h5ai.git
|
||||||
> cd h5ai
|
> cd h5ai
|
||||||
|
@ -27,6 +32,7 @@ You'll find a new directory `build` including a fresh zipball.
|
||||||
|
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
The MIT License (MIT)
|
The MIT License (MIT)
|
||||||
|
|
||||||
Copyright (c) 2014 Lars Jung (http://larsjung.de)
|
Copyright (c) 2014 Lars Jung (http://larsjung.de)
|
||||||
|
@ -51,6 +57,7 @@ THE SOFTWARE.
|
||||||
|
|
||||||
|
|
||||||
## References
|
## References
|
||||||
|
|
||||||
**h5ai** profits from these great projects:
|
**h5ai** profits from these great projects:
|
||||||
[Gnome Symbolic Icon Theme](https://git.gnome.org/browse/gnome-icon-theme-symbolic/) (CC BY-SA 3.0),
|
[Gnome Symbolic Icon Theme](https://git.gnome.org/browse/gnome-icon-theme-symbolic/) (CC BY-SA 3.0),
|
||||||
[HTML5 ★ Boilerplate](http://html5boilerplate.com) (MIT),
|
[HTML5 ★ Boilerplate](http://html5boilerplate.com) (MIT),
|
||||||
|
|
Loading…
Reference in a new issue