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

Minimal documentation/readme #41

Closed
kolayne opened this issue Nov 1, 2020 · 3 comments
Closed

Minimal documentation/readme #41

kolayne opened this issue Nov 1, 2020 · 3 comments

Comments

@kolayne
Copy link

kolayne commented Nov 1, 2020

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.

@CoffeBee
Copy link
Owner

CoffeBee commented Dec 4, 2020

We push our first readme version, we are waiting for your proposal about it)

@kolayne
Copy link
Author

kolayne commented Dec 5, 2020

Well, to my mind the README suffers from mentioning all the requirements as a command (while it could and should have been moved to requirements.txt), but now I understand how to run the project, so you can close the issue if you think it's resolved

By the way, isn't the following line a typo?
'PASSWORD' : '<YOUR_DATABASE_PASSWORD_HERE>gres',
If no, you probably need to state it explicitly

@CoffeBee
Copy link
Owner

CoffeBee commented Dec 5, 2020

Typo with Password fixed in 57fc997, requirements.txt will be added later.

@CoffeBee CoffeBee closed this as completed Dec 5, 2020
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

2 participants