mirror of
https://github.com/lrsjng/h5ai.git
synced 2025-05-28 14:04:45 -04:00
Updates readme.
This commit is contained in:
parent
cec6ca2e6e
commit
2c8940d062
1 changed files with 6 additions and 10 deletions
16
README.md
16
README.md
|
@ -7,25 +7,21 @@ create [a new issue](http://github.com/lrsjng/h5ai/issues/new) on GitHub!
|
||||||
|
|
||||||
## Install
|
## Install
|
||||||
|
|
||||||
( **note:** please don't use files from the `src` folder for installation,
|
**Note:** please don't use files from the `src` folder for installation,
|
||||||
they need to be preprocessed to work correctly )
|
they need to be preprocessed to work correctly!
|
||||||
|
|
||||||
You'll find a preprocessed package, as well as detailed installation
|
You'll find a preprocessed package, as well as detailed installation
|
||||||
instructions on the [project page](http://larsjung.de/h5ai/).
|
instructions on the [project page](http://larsjung.de/h5ai/).
|
||||||
|
|
||||||
|
|
||||||
## Build
|
## Build
|
||||||
|
|
||||||
( there are repositories for the latest [releases](http://release.larsjung.de/h5ai/) and [dev builds](http://release.larsjung.de/h5ai/dev/) )
|
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:
|
||||||
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
|
||||||
|
|
||||||
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` to see if everything
|
||||||
worked fine.
|
worked fine. To clone and build the project run the following commands.
|
||||||
|
|
||||||
To clone and build the project run the following commands.
|
|
||||||
You'll find a new directory `build` including a fresh zipball.
|
You'll find a new directory `build` including a fresh zipball.
|
||||||
|
|
||||||
> git clone git://github.com/lrsjng/h5ai.git
|
> git clone git://github.com/lrsjng/h5ai.git
|
||||||
|
@ -56,7 +52,7 @@ It profits from these great projects:
|
||||||
|
|
||||||
|
|
||||||
## Changelog
|
## Changelog
|
||||||
( **h5ai** uses [semantic versioning](http://semver.org/) )
|
**h5ai** uses [semantic versioning](http://semver.org/).
|
||||||
|
|
||||||
|
|
||||||
### develop branch
|
### develop branch
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue