-
Notifications
You must be signed in to change notification settings - Fork 3
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
Minimal documentation/readme #41
Comments
We push our first readme version, we are waiting for your proposal about it) |
Well, to my mind the README suffers from mentioning all the requirements as a command (while it could and should have been moved to By the way, isn't the following line a typo? |
Typo with Password fixed in 57fc997, requirements.txt will be added later. |
This would be nice if you'd add some minimal documentation and/or a "Usage" or "Executing" section to README.md. Either of them should explain how do I run my own instance of MathBattle. It is important because without such instruction it's really hard for newcomers to start contributing to your project, among other reasons.
The text was updated successfully, but these errors were encountered: