search

twelve-of-code-official / website

The source code for the Twelve of Code website
https://mesure.x10.mx/twelve-of-code
GNU General Public License v3.0
0 stars 0 forks source link

Create a new README #192

Open Mesure73L opened 5 months ago

Mesure73L commented 5 months ago

I don't know what I should say in the README. Any ideas?

BeepBot99 commented 5 months ago

How about you use this layout:

Note that READMEs are usually not centered, so please do not do that.

  1. Introduction, 1 to 3 paragraphs
  2. Badges from shields.io
  3. Table of contents (with a nested list for each heading, using this.)
  4. Screenshots of parts of the website
  5. Resources for creating your own challenges
  6. Support, where to go for help
  7. Roadmap, list of current ideas for the future and features that are being worked on
  8. Contributing
  9. Acknowledgments, credits, and all the libraries that we used
  10. License
Mesure73L commented 5 months ago

How about you use this layout:

Note that READMEs ...

How about this instead?

  1. Introduction, 1 to 3 paragraphs
  2. Badges from shields.io
  3. Table of contents (with a nested list for each heading, using this.)
  4. Screenshots of parts of the website
  5. Resources for creating your own challenges This will be in docs/challenges library
  6. Support, where to go for help
  7. Roadmap, list of current ideas for the future and features that are being worked on
  8. Contributing There is another tab for it
  9. Acknowledgments, credits, and all the libraries that we used
  10. License There is another tab for it
BeepBot99 commented 5 months ago
  • ~Resources for creating your own challenges~ This will be in docs/challenges library

That is fine if you really want, but I think it would be best to just say a quick thing about it.

And no, there is not a tab for contributing, just a file. The name of the license and how to contribute and everything you will ever need always goes in the README too, even if it is somewhere else too. The README is supposed to be a summary of everything.

Mesure73L commented 5 months ago
  • ~Resources for creating your own challenges~ This will be in docs/challenges library

That is fine if you really want, but I think it would be best to just say a quick thing about it.

I will provide a link to the docs.

And no, there is not a tab for contributing, just a file.

Oh right, but it still gives a link when you're actually contributing.

The name of the license and how to contribute and everything you will ever need always goes in the README too, even if it is somewhere else too. The README is supposed to be a summary of everything.

I don't think we should put the license in it when it's literally in the same place as the README.

Mesure73L commented 5 months ago

Nevermind, you're right. I found this really cool template and I think we should use it.

Mesure73L commented 5 months ago

If we decide to use that, I will edit it to fit our needs of Twelve of Code.

BeepBot99 commented 5 months ago

Sure, you can use that.

Nevermind, you're right

Yeah, I know, I've created READMEs for many open source projects. On my old GitHub account, I created some of the README for vue.js.

Mesure73L commented 5 months ago

Nevermind, you're right

Yeah, I know, I've created READMEs for many open source projects. On my old GitHub account, I created some of the README for vue.js.

Oh nice!