aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authordotnetCarpenter <jon.ronnenberg@gmail.com>2016-11-12 23:28:35 +0100
committerdotnetCarpenter <jon.ronnenberg@gmail.com>2016-11-12 23:49:22 +0100
commit6380b23d6f6cc1513b831b97cb82db3a78cc7489 (patch)
tree45ddf0e2647667900df5dcdb8b9fb963b31a7284
parent8f63acccf2b9bbb539c44e5684b56295294196d3 (diff)
downloadsvg.js-6380b23d6f6cc1513b831b97cb82db3a78cc7489.tar.gz
svg.js-6380b23d6f6cc1513b831b97cb82db3a78cc7489.zip
added small paragraph about on how to prevent pushing failing commits
-rw-r--r--README.md8
1 files changed, 6 insertions, 2 deletions
diff --git a/README.md b/README.md
index 6d39156..6d69d1b 100644
--- a/README.md
+++ b/README.md
@@ -4075,13 +4075,13 @@ Before running the specs you will need to build the library. Be aware that pull
## Building
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
+```sh
$ npm install
```
Build SVG.js by running `gulp`:
-``` sh
+```sh
$ npm run build
```
@@ -4100,6 +4100,10 @@ $ npm test
To run the test suite in your default browser, simply open `/spec/SpecRunner.html`. Usually by double click.
+If you are the cautious type, you might want to read,
+[before you push](https://github.com/svgdotjs/svg.js/wiki/Before-you-push)
+, on how to prevent pushing failing commits.
+
## Compatibility
### Desktop