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.

Sign up for GitHub

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

Jump to bottom

Any chance of getting prereqs in README.md? #6

Open
davidlmobley opened this issue Nov 23, 2018 · 1 comment
Open

Any chance of getting prereqs in README.md? #6

davidlmobley opened this issue Nov 23, 2018 · 1 comment

Comments

@davidlmobley
Copy link

We're debating whether to link to this in the author instructions for LiveCoMS as a "potentially helpful tool to catch errors" or similar, but one thing that would probably help with that would be if the main README.md had a bit more info on getting going with it and what prereqs are needed to be installed first.

I realize this is not your main gig, but perhaps just a minimal amount of more effort can get it to the point where it will be broadly useful for a number of people and other people will want to help keep it going/improve it.
@jaimergp
Copy link
Owner

Hi @davidlmobley!

That would be awesome! I have updated the README with installation instructions, usage and comments on how it works and how it could be improved. Let me know if this is enough.

Cheers,
Jaime.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@jaimergp @davidlmobley