thereadme/Equation.js
1
0
Fork 0
Code Issues 4 Pull Requests 3 Projects Releases Wiki Activity

Contributing section

Browse Source
This commit is contained in:
Mahdi Dibaiee 2015-04-20 15:43:29 +04:30
parent a589a4d744
commit 61524708f1
1 changed files with 22 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -61,6 +61,28 @@ Options:
Registers a new constant. value can be a function (takes no arguments), or a constant number. Registers a new constant. value can be a function (takes no arguments), or a constant number.
That's right, we have named these *constants* but they actually can change, that's why we can use functions to define them. An example is the `RAND` constant which calls `Math.random`. That's right, we have named these *constants* but they actually can change, that's why we can use functions to define them. An example is the `RAND` constant which calls `Math.random`.
Contributing
============
The code is commented and I hope you don't have a hard time contributing,
anyway, some tips about contributing:
The source code is in `lib` directory and is then transpiled into `dist`.
#####Grunt Tasks
######default
Transpiles `lib` to `dist`
######build
Transpiles, browserifies, uglifies
######eslint
Runs ESLint on `lib` and `tests`
######test
Runs the tests
Please make sure to run `grunt eslint` before commiting.
If you're adding something new, please add a test, too.
TODO TODO
==== ====
* Equation solver * Equation solver