diff options
| author | Ulrich-Matthias Schäfer <ulima.ums@googlemail.com> | 2018-12-01 18:58:16 +0100 |
|---|---|---|
| committer | Ulrich-Matthias Schäfer <ulima.ums@googlemail.com> | 2018-12-01 18:58:16 +0100 |
| commit | a887081c7a71aa0177e886dba79f3187a6c226d6 (patch) | |
| tree | cc7f904a1cbdbd60165874661e8b40761eb06798 | |
| parent | 1edcc976b8db981ba2398036b3a39c4de4791a86 (diff) | |
| download | svg.js-a887081c7a71aa0177e886dba79f3187a6c226d6.tar.gz svg.js-a887081c7a71aa0177e886dba79f3187a6c226d6.zip | |
cleaup readme, the info is in the docs
| -rw-r--r-- | README.md | 32 |
1 files changed, 0 insertions, 32 deletions
@@ -32,35 +32,3 @@ SVG.js is licensed under the terms of the MIT License. Check [svgjs.com](https://svgjs.com) to learn more. [](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=pay%40woutfierens.com&lc=US&item_name=SVG.JS¤cy_code=EUR&bn=PP-DonationsBF%3Abtn_donate_74x21.png%3ANonHostedGuest) - -## Development - -To develop svg.js, you have a few commands available to you. Firstly, you should clone this repo, then cd into the folder with this README and run: - - npm install - -You'll now have all the dev dependencies installed, and you'll be ready to build the bundle. Once you've made your changes just run: - - npm run build - -This will build svg.js and make a distribution in the `/dist` folder. While developing, this may not be so convenient as the build will fail if you have any linting errors, refer to the [standard coding styleguide](https://standardjs.com/) for style we use, linters are available for most popular text editors as well. - -### Testing - -This will set up everything. While you are working, you should make sure your changes pass all of our tests, so just run: - - npm run test - -Or just launch the jasmine test runner from `/spec/SpecRunner.html`. Its good to try the spec runner on a few different browsers. - -### Performance - -You can run performance tests by making a new benchmarks, look in the `/bench` folder and just add a new js file with the test you want to make. We include a few examples in the repo to make it easy for you to make your own. - -### Playgrounds - -If you would like a simple sandbox that you can use, take a look into the sandbox folder. - -## Pull Requests - -We welcome any pull requests and will try our hardest to review them as soon as possible. If you need any help or would like to chat, check out our [gitter group](https://gitter.im/svgdotjs/svg.js?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge), we are always happy to see new users! |