mirror of
https://github.com/lrsjng/h5ai.git
synced 2025-05-25 20:44:53 -04:00
Updates readme.
This commit is contained in:
parent
bfd8f1b5e0
commit
906d83a3b0
1 changed files with 4 additions and 9 deletions
13
README.md
13
README.md
|
@ -7,8 +7,8 @@ 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/).
|
||||||
|
@ -16,8 +16,7 @@ instructions on the [project page](http://larsjung.de/h5ai/).
|
||||||
|
|
||||||
## Build
|
## Build
|
||||||
|
|
||||||
A prebuilt package of the latest release can be found on the [project page](http://larsjung.de/h5ai/).
|
(there are repositories of the latest [releases](http://release.larsjung.de/h5ai/) and [dev builds](http://release.larsjung.de/h5ai/dev/))
|
||||||
There is also a repository of the [latest dev builds](http://release.larsjung.de/h5ai/dev/).
|
|
||||||
|
|
||||||
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:
|
||||||
|
|
||||||
|
@ -27,14 +26,10 @@ This will install fQuery and its command line tool `makejs`. Run `makejs --help`
|
||||||
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 the processed files.
|
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
|
||||||
> cd h5ai
|
> cd h5ai
|
||||||
> makejs
|
|
||||||
|
|
||||||
To create an fresh zipball run
|
|
||||||
|
|
||||||
> makejs release
|
> makejs release
|
||||||
|
|
||||||
|
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue