Skip to content

Improve readme#160

Merged
drathier merged 2 commits intoelm-explorations:masterfrom
lydell:improve-readme
Nov 21, 2020
Merged

Improve readme#160
drathier merged 2 commits intoelm-explorations:masterfrom
lydell:improve-readme

Conversation

@lydell
Copy link
Contributor

@lydell lydell commented Nov 15, 2020

Leave the node-test-runner installation and usage instructions to node-test-runner’s readme.

Together with rtfeldman/node-test-runner#473, this fixes rtfeldman/node-test-runner#249.

README.md Outdated

* [`travis.yml`](https://github.com/rtfeldman/elm-css/blob/master/.travis.yml)
* [`appveyor.yml`](https://github.com/rtfeldman/elm-css/blob/master/appveyor.yml)
Head over to the [CLI test runner](https://github.com/rtfeldman/node-test-runner) for instructions on how to get started!
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd like a short paragraph/sentence explaining that this is the test library which you use to write tests, and that you need a test runner such as node-test-runner to actually run the tests. There are more than one test runner, so I wouldn't want to talk about it as the test runner, even though it's the most popular one now by far.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, I know of a private closed source test runner

@drathier
Copy link
Collaborator

LGTM, thanks!

@drathier drathier merged commit faa2061 into elm-explorations:master Nov 21, 2020
@lydell lydell deleted the improve-readme branch November 21, 2020 10:25
harrysarson pushed a commit to rtfeldman/node-test-runner that referenced this pull request Jan 20, 2021
- Recommend installing locally. Fixes #249.
- Move more common flags first, both in the readme and in `--help`.
- Sync the descriptions between the readme and `--help`.
- Try to explain the difference between node-test-runner and elm-explorations/test.
- Document where to put your tests.
- Various other little tweaks to try to be more helpful.

PR for elm-explorations/test: elm-explorations/test#160

We should also update the repo description because it currently says:

> Runs elm-test suites from Node.js. Get it with npm install -g elm-test
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Recommend local rather than global install

3 participants