Skip to content

Commit d2d2da9

Browse files
committed
Update readme to include building and testing section.
1 parent c9971d7 commit d2d2da9

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

README.md

+18
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,24 @@ For a full list of options, see the [options documentation](http://www.sceditor.
4040

4141

4242

43+
## Building and testing
44+
45+
You will need [Grunt](http://gruntjs.com/) installed to run the build/tests. To install Grunt run:
46+
47+
npm install -g grunt-cli
48+
49+
Next, to install the SCEditor dev dependencies run:
50+
51+
npm install
52+
53+
That's it! You can now build and test SCEditor with the following commands:
54+
55+
grunt build # Minifies the JS and converts the LESS to CSS
56+
grunt test # Runs the linter and unit tests
57+
grunt dist # Creates the distributable ZIP file
58+
59+
60+
4361
## Contribute
4462

4563
Any contributions and/or pull requests would be welcome.

0 commit comments

Comments
 (0)