Update syntax highlighting in README
parent
646e58b434
commit
fe2d206c5a
38
README.md
38
README.md
|
@ -21,7 +21,7 @@ A JavaScript SVG library for the modern web. Learn more at [snapsvg.io](http://s
|
||||||
|
|
||||||
In your HTML file, load simply by:
|
In your HTML file, load simply by:
|
||||||
```html
|
```html
|
||||||
<script src="snap.svg-min.js"></script>`
|
<script src="snap.svg-min.js"></script>
|
||||||
```
|
```
|
||||||
No other scripts are needed. Both the minified and uncompressed (for development) versions are in the `/dist` folder.
|
No other scripts are needed. Both the minified and uncompressed (for development) versions are in the `/dist` folder.
|
||||||
|
|
||||||
|
@ -35,19 +35,19 @@ const Snap = require(`imports-loader?this=>window,fix=>module.exports=0!snapsvg/
|
||||||
Snap.svg uses [Grunt](http://gruntjs.com/) to build.
|
Snap.svg uses [Grunt](http://gruntjs.com/) to build.
|
||||||
|
|
||||||
* Open the terminal from the Snap.svg directory:
|
* Open the terminal from the Snap.svg directory:
|
||||||
|
```sh
|
||||||
cd Snap.svg
|
cd Snap.svg
|
||||||
|
```
|
||||||
* Install its command line interface (CLI) globally:
|
* Install its command line interface (CLI) globally:
|
||||||
|
```sh
|
||||||
npm install -g grunt-cli
|
npm install -g grunt-cli
|
||||||
|
```
|
||||||
_*You might need to use `sudo npm`, depending on your configuration._
|
_*You might need to use `sudo npm`, depending on your configuration._
|
||||||
|
|
||||||
* Install dependencies with npm:
|
* Install dependencies with npm:
|
||||||
|
```sh
|
||||||
npm install
|
npm install
|
||||||
|
```
|
||||||
_*Snap.svg uses Grunt 0.4.0. You might want to [read](http://gruntjs.com/getting-started) more on their website if you haven’t upgraded since a lot has changed._
|
_*Snap.svg uses Grunt 0.4.0. You might want to [read](http://gruntjs.com/getting-started) more on their website if you haven’t upgraded since a lot has changed._
|
||||||
|
|
||||||
* Type `grunt` in the command line to build the files.
|
* Type `grunt` in the command line to build the files.
|
||||||
|
@ -59,18 +59,18 @@ _*Snap.svg uses Grunt 0.4.0. You might want to [read](http://gruntjs.com/getting
|
||||||
* [Fill out the CLA](http://snapsvg.io/contributions/).
|
* [Fill out the CLA](http://snapsvg.io/contributions/).
|
||||||
* [Fork](https://help.github.com/articles/fork-a-repo) the repo.
|
* [Fork](https://help.github.com/articles/fork-a-repo) the repo.
|
||||||
* Create a branch:
|
* Create a branch:
|
||||||
|
```sh
|
||||||
git checkout -b my_branch
|
git checkout -b my_branch
|
||||||
|
```
|
||||||
* Add your changes.
|
* Add your changes.
|
||||||
* Commit your changes:
|
* Commit your changes:
|
||||||
|
```sh
|
||||||
git commit -am "Added some awesome stuff"
|
git commit -am "Added some awesome stuff"
|
||||||
|
```
|
||||||
* Push your branch:
|
* Push your branch:
|
||||||
|
```sh
|
||||||
git push origin my_branch
|
git push origin my_branch
|
||||||
|
```
|
||||||
* Make a [pull request](https://help.github.com/articles/using-pull-requests) to `dev`(!) branch.
|
* Make a [pull request](https://help.github.com/articles/using-pull-requests) to `dev`(!) branch.
|
||||||
|
|
||||||
*Note:* Pull requests to other branches than `dev` or without filled CLA wouldn’t be accepted.
|
*Note:* Pull requests to other branches than `dev` or without filled CLA wouldn’t be accepted.
|
||||||
|
|
Loading…
Reference in New Issue