aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorwout <wout@impinc.co.uk>2014-07-13 10:32:20 +0200
committerwout <wout@impinc.co.uk>2014-07-13 10:32:20 +0200
commite9a0d5f5d7074b1cb3d1bd5a00f6a602bd55f983 (patch)
tree709af264123ce66ebafb8490d84cceb6d5b8b97a /README.md
parent40bf2f8ecda3f426e7f13e1d891ab1ab6e004116 (diff)
downloadsvg.js-e9a0d5f5d7074b1cb3d1bd5a00f6a602bd55f983.tar.gz
svg.js-e9a0d5f5d7074b1cb3d1bd5a00f6a602bd55f983.zip
Switched to gulp for building
Diffstat (limited to 'README.md')
-rwxr-xr-xREADME.md36
1 files changed, 6 insertions, 30 deletions
diff --git a/README.md b/README.md
index ffcc796..5ed7de5 100755
--- a/README.md
+++ b/README.md
@@ -3325,47 +3325,23 @@ Be aware that pull requests without specs will be declined.
## Building
-Starting out with the default distribution of SVG.js is good. Although you might want to remove some modules to keep the size at minimum.
-
-You will need ruby, RubyGems, and rake installed on your system.
+After contributing you probably want to build the library to run some specs. Make sure you have Node.js installed on your system, `cd` to the svg.js directory and run:
``` sh
-# dependencies:
-$ ruby -v
-$ gem -v
-$ rake -V
-
-# required to generate the minified version:
-$ gem install uglifier
+$ npm install
```
-Build SVG.js by running `rake`:
+Build SVG.js by running `gulp`:
``` sh
-$ rake
-Original version: 32.165k
-Minified: 14.757k
-Minified and gzipped: 4.413k, compression factor 7.289
+$ gulp
```
The resulting files are:
-1. `dist/SVG.js`
+1. `dist/svg.js`
2. `dist/svg.min.js`
-To include optional modules and remove default ones, use the `concat` task. In
-this example, 'clip' is removed, but 'group' and 'arrange' are added:
-
-``` sh
-$ rake concat[-clip:group:arrange] dist
-```
-
-To build the base library only including shapes:
-
-``` sh
-rake concat[-fx:-event:-group:-arrange:-mask:-gradient:-nested:-sugar] dist
-```
-
## Compatibility
@@ -3374,7 +3350,7 @@ rake concat[-fx:-event:-group:-arrange:-mask:-gradient:-nested:-sugar] dist
- Chrome 4+
- Safari 3.2+
- Opera 9+
-- IE9 +
+- IE9+
### Mobile
- iOS Safari 3.2+