Upgrade Your GitHub README.md 3.5

#github #githubactions #beginners #tutorial

Have you made your first issue on Github? Has it been closed?

Want an easy way to bypass this AND have a README.md that stands out?

Time to make your own chess game within your README.md!!
Yes the community can play it. Yes it's amazing! Yes, there's a template! Check out mine! Go ahead and play!

Let's start with how it works:

A player clicks a link to choose which move they would like to make. This link automatically creates a new issue with the correctly populated information. The player then just needs to submit the issue to make the move. This triggers a python script and updates the README.md file and commits the changes.

Let's get started
Within your main repo, you'll make the following folders:
data, games, img, src, tests

Inside img, you'll make a folder named "black" and another named "white".

Onto the code:
Don't worry, there's a template!!

MIT License

Copyright (c) 2020 Marc Izquierdo

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Top comments (3)

Marc • May 9 '23

Hey Tina! I'm the author of that project. First of all, many thanks for writing about it and I'm happy to hear that you're enjoying it!!

I'd like to mention a few things. The most important one is that since the project is a GitHub template, the intended (and easiest way) to set it up is by clicking the "Use this template" button. That way you don't have to manually copy and paste so much code nor manually set up the internal state of the chess game (games/current.pgn, data/last_moves.txt, data/top_moves.txt, etc...) and everything works out of the box.

Another thing is that you don't really need any of the files inside the folder tests/. As the name implies, those are just unit tests used for development and as such you can safely delete them if you wish in order to save up space or maintain the repo as small as possible.

Finally, something important I'd like to mention is that even though the project is open source and you're completely free to use it and distribute it, it is licensed under the MIT license. This means that you're completely free to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the software; but you must not claim ownership of the code and the Copyright notice shall be included in all copies or substantial portions of the Software. This is another reason why I think it's important to generate a repo from the template and not manually.

I hope you understand. We all love to see people use our projects but we also like some attribution back :)

Once again, great article! And if you have some ideas on how to improve it please reach out or feel free to open a PR! :D