Skip to content
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 #68

Closed
kytrinyx opened this issue Mar 16, 2015 · 3 comments
Closed

Add helpful information to the SETUP.md #68

kytrinyx opened this issue Mar 16, 2015 · 3 comments

Comments

@kytrinyx
Copy link
Member

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.

@wachr
Copy link
Contributor

wachr commented Mar 23, 2015

Hi @kytrinyx, I just created a pull request for a patch for this. I'm pretty new to Github so apologies if I overlooked some convention or contributing rules. I'd really like to participate in something on Gtihub and I've very much enjoyed Exercism so any feedback or criticism is welcome and I will try to respond promptly.

@etrepum
Copy link
Contributor

etrepum commented Mar 23, 2015

Thanks @wachr!

@etrepum etrepum closed this as completed Mar 23, 2015
@kytrinyx
Copy link
Member Author

This looks great, thanks!

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

No branches or pull requests

3 participants