Skip to content

Commit c595b65

Browse files
committed
Update README.md
1 parent 8f25b0e commit c595b65

1 file changed

Lines changed: 47 additions & 2 deletions

File tree

README.md

Lines changed: 47 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,47 @@
1-
# toyproblems
2-
Toy Problems that I've attempted
1+
# Testing ToyProblems
2+
3+
My solution for testing toy problems and algorithims written in Javascript for the Browser.
4+
5+
## Requirements
6+
This suite requires bower, npm, and node.
7+
8+
## Installation
9+
1. Either fork this repo, or just download the latest release directly.
10+
2. Open a terminal window, and cd into the testing-toyproblems directory.
11+
3. Run: `bower install`
12+
4. Duplicate the _template directory and rename to whatever your first problem is.
13+
5. Write your tests in the spec.js file.
14+
6. Write (or copy and paste) your algorithim in the src.js file.
15+
7. Run SpecRunner.html
16+
8. Enjoy some TDD!! :)
17+
18+
## Upgrading
19+
If you add this repository as an upstream remote, then if any changes are made to the template or other core files, you can just do a `git pull` for it to work.
20+
21+
## Contributing
22+
Feel free to open issues on this github repo with any issues or bugs you encounter. If you find a bug, or want to add a feature, fork the repo, make your change, and create a pull request.
23+
24+
## Credits
25+
Inspired by the great work of [Phillip Alexander](https://github.com/phillipalexander/generator-test)
26+
27+
## License
28+
(The MIT License)
29+
30+
Permission is hereby granted, free of charge, to any person obtaining
31+
a copy of this software and associated documentation files (the
32+
'Software'), to deal in the Software without restriction, including
33+
without limitation the rights to use, copy, modify, merge, publish,
34+
distribute, sublicense, and/or sell copies of the Software, and to
35+
permit persons to whom the Software is furnished to do so, subject to
36+
the following conditions:
37+
38+
The above copyright notice and this permission notice shall be
39+
included in all copies or substantial portions of the Software.
40+
41+
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
42+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
43+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
44+
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
45+
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
46+
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
47+
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

0 commit comments

Comments
 (0)