Permalink
Browse files

Updated instructions

  • Loading branch information...
1 parent 97797ea commit c908d602df5c0819b0396f9318c4174bb26cb727 @jussi-kalliokoski committed Apr 25, 2012
Showing with 39 additions and 58 deletions.
  1. +25 −32 BUILD.md
  2. +10 −14 INSTALL.md
  3. +4 −12 README.md
View
@@ -8,77 +8,70 @@ This is a simple operation, just joins all the scripts in ``js/`` together in th
Operation:
-``
-
-git submodule --init
-make main
-
-``
+```
+$ grunt
+```
If you need to minify as well:
-``
-
-make minify
-
-``
+```
+$ grunt default min
+```
Dependencies:
* A terminal (emulator)
* git
- * make
- * (con)cat
- * A minifier (optional, defaults to uglifyjs, install via npm `` sudo npm install uglifyjs -g ``)
+ * [grunt](http://gruntjs.com/)
## Integration
-Integrates bundled packages to audiolib.js. To run this operation, you must first have the submodules ready, and it doesn't make much sense unless you update them to the latest version first as well, say we wanted to update `` sink.js ``:
+Integrates bundled packages to audiolib.js. To run this operation, you must first have the submodules ready, and it doesn't make much sense unless you update them to the latest version first as well, say we wanted to update ``` sink.js ```:
-``sh
+```sh
git submodule update --init
-cd integration/sink.js
+cd dependencies/sink.js
git pull origin master
cd ../..
make integrate all # all is optional, but recommended so that you can see if the tests still run fine.
-``
+```
Dependencies:
* A terminal (emulator)
* make
* git
* sh
- * (con)cat
+ * [grunt](http://gruntjs.com/)
## Templates
Some files of audiolib.js are generated from templates, such as the wrappers, package and documentation. You can find these templates from the `` templates/ `` directory. After updating certain things such as the version, you might want to remake these things from the tempates, and that can be done with these simple commands.
-``sh
+```sh
-make wrappers
-make package
-make docs
+grunt wrappers
+grunt package
+grunt docs
# Or to update all
-make update
+grunt update
# You'll probably also want to do this to update the lib/
-make all
+grunt all
-``
+```
Dependencies:
* A terminal (emulator)
- * make
* sh
* nodejs
* npm
- * paramon & script-builder (npm packages, installation: `` npm install paramon script-builder ``)
- * (OPTIONAL) for automatic minification of the docs: `` npm install uglify-js html-minifier clean-css ``
+ * paramon & script-builder (npm packages, installation: ``` npm install paramon script-builder ```)
+ * [grunt](http://gruntjs.com/)
+ * (OPTIONAL) for automatic minification of the docs: ``` npm install uglify-js html-minifier clean-css ```
## Config
-The aforementioned templates are affected by source files and configuration data. The configuration data contains things such as the version. To change configurations you can either edit ``templates/variables.json`` directly or recommendedly via the config command. Example uses of the config command:
+The aforementioned templates are affected by source files and configuration data. The configuration data contains things such as the version. To change configurations you can either edit ```templates/variables.json``` directly or recommendedly via the config command. Example uses of the config command:
``sh
@@ -92,12 +85,12 @@ The aforementioned templates are affected by source files and configuration data
``
-After making changes to the config it's recommended to run `` make update all `` to update template generated data and lib/ files to be able to test whether the changes work.
+After making changes to the config it's recommended to run ``` grunt update all ``` to update template generated data and lib/ files to be able to test whether the changes work.
Dependencies:
* A terminal (emulator)
- * make
* sh
* nodejs
* npm
* paramon & script-builder (npm packages, installation: `` npm install paramon script-builder ``)
+ * [grunt](http://gruntjs.com/)
View
@@ -2,36 +2,32 @@
## Server side
-You need to have node.js v.0.2 or higher (>=0.5.5 recommended), see http://www.nodejs.org for further information about node.js.
+You need to have node.js v.0.6 or higher, see http://www.nodejs.org for further information about node.js.
-You'll also need npm ( see http://npmjs.org ).
+You'll also need [npm](http://npmjs.org/) and [grunt](http://gruntjs.com/).
-After you have both, to install the latest stable version to be available in your working directory, run this in your terminal:
-
-``
+After you have all of those, to install the latest stable version to be available in your working directory, run this in your terminal:
+```
$ npm install audiolib
+```
-``
-
-Add a ``-g`` flag to install globally.
+Add a ```-g``` flag to install globally.
To install from the repo, e.g. for testing purposes, run this in your terminal.
-``
-
+```
$ npm install /path/to/audiolib/repo/
-
-``
+```
## Client-side
Simply include either the minified or the full .js file on your page and you're good to go. Also works with certain package managers. Feel free to report an issue if it's not working with your preferred package manager.
-``html
+```html
<script src="audiolib.js"></script>
-``
+```
Enjoy!
View
@@ -34,15 +34,7 @@ To install via npm:
$ npm install audiolib
```
-### Windows
-
-For Windows and npm, you'll need [GNU Make](http://gnuwin32.sourceforge.net/packages/make.htm). You'll also need to set the ```$PATH``` variable properly. In Powershell, you should do this before running the npm install:
-
-```
-PS> $env:Path = "$env:Path;C:\Program Files\GnuWin32\bin\"
-```
-
-Where the path after the semicolon is the path to the directory you installed your GNU utilities in.
+Please note that you'll need [grunt](http://gruntjs.com/) for this to work.
### Browser
@@ -64,9 +56,9 @@ Documentation is available at http://docs.audiolibjs.org/ . Tutorials can be fou
## Libraries bundled with audiolib.js
* [sink.js](https://github.com/jussi-kalliokoski/sink.js), for output and buffer handling.
-* [PCMData.js](https://github.com/jussi-kalliokoski/pcmdata.js), for WAV codecs.
-* [binary.js](https://github.com/jussi-kalliokoski/binary.js), for PCMData.js and general binary data processing.
-* [fft.js](https://github.com/jussi-kalliokoski/fft.js), for super fast FT.
+* [PCMData.js](https://github.com/jussi-kalliokoski/pcmdata.js), for WAV codecs. (project deprecated and adopted)
+* [binary.js](https://github.com/jussi-kalliokoski/binary.js), for PCMData.js and general binary data processing. (project deprecated and adopted)
+* [fft.js](https://github.com/jussi-kalliokoski/fft.js), for super fast FT. (project deprecated and adopted)
## Related libraries

0 comments on commit c908d60

Please sign in to comment.