Updated README for consistency and readability #128
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I've updated the test README a bit since I was struggling with getting started with tests. The formatting on Github was quite broken. I feel the README still needs some work, but I need some guidance, so here are questions for discussion:
Are these running the same test suite, only one in node and the other in browser via jasmine? Or do the suites differ in content? (Misleading that one is called "core unit-tests" and the other "unit tests using jasmine"
node test/server.js
vsnode test/jasmine-test/server/specRunner.js
vsmake test
vsmake jasmine
What is the difference between these two styles of calling node.js tests? Does one cover just core and the other full test suite? Are they identical? Why list all four?!
Reason: the recommended node.js practice is NOT to install global packages for project-specific development. Since
cover
is already listed as a dependency and thus installed vianpm install
, you can already run it via./node_modules/.bin/cover
- and there's no need installing it again into global namespace. However, the path is a bit cumbersome, so I propose makingmake cover
andmake cover-help
or just dropping these intructions in favour of existing umbrellamake coverage
(but fixing the path to be local).