New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add helpful information to the SETUP.md #23
Comments
This is hard to do at the moment since we're not sure yet how the tests will run in the future (i.e. whether cargo will be involved or not). |
I just submitted another PR (#26) to get all the examples working with Cargo.
The question is should we follow the Nightly or Beta channel? |
Yeah, it's better to hold off until that has been resolved. |
@bitborn We would only have to recommend Nightly or Beta until May 15th, which is when 1.0.0 is planned to ship. |
I don't really understand where exactly the SETUP.md file is included. |
When the README for each exercise is assembled, it takes:
|
In that order I assume? |
Here it is: #28 |
Yup, looks great. |
The contents of the SETUP.md file gets included in
the README.md that gets delivered when a user runs the
exercism fetch
command from their terminal.
At the very minimum, it should contain a link to the relevant
language-specific documentation on
help.exercism.io.
It would also be useful to explain in a generic way how to run the tests.
Remember that this file will be included with all the problems, so it gets
confusing if we refer to specific problems or files.
Some languages have very particular needs in terms of the solution: nested
directories, specific files, etc. If this is the case here, then it would be
useful to explain what is expected.
Thanks, @tejasbubane for suggesting that we add this documentation everywhere.
See exercism.io#2198.
The text was updated successfully, but these errors were encountered: