-
Notifications
You must be signed in to change notification settings - Fork 12
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
Improve README.md file #57
Comments
@Kerveyfelix - Installation procedures are laid out on our README, and all students are supposed to read contribution guidelines from the NWoC github repo itself, so we are not adding contributing guidelines to the project. Basic instructions are laid out in README. You may however make changes to the README by making it more attractive. Maybe a list of contributors, maintainers (*only myself right now) or some badges, also improve the Codemon Header using some new font or JPG. But make sure to keep it minimal and simple. We don't want to clutter our readme with a lot of colourful stickers or emojis. |
Noted. I can work on README.md updation without overcrowding it with stick, gif and other things. |
@Kerveyfelix - If you're working on the README, note that will the merge of #55 , we have lots of new features for codemon such as support for languages such as java & Python and also automated fetching of inputs or outputs from the codeforces website. So make sure to include those points on the README. Thanks ! |
Noted. |
Another thing, please get rid of the current GIF and update it with a new GIF, which displays the current working of Codemon (let me know if you encounter problems using the commands). |
Noted. |
Pip is not working on my PC. |
@Kerveyfelix - What's the error exactly? Did you install pip3 properly ? Or you're unable to install codemon using pip3 ? |
@ankingcodes Can I work on this as it is a good first issue for beginners like me. |
@sourav-suku - you can go ahead and make a PR for it. If @Kerveyfelix also sends in a PR, I'll merge the better one. |
Done via 5eeec42 |
I think it is important to have contributing guidelines so that an open-source contributor know how to contribute properly.
Can I work on this?
The text was updated successfully, but these errors were encountered: