- About Better-README
- Getting Started
- API
- Contributing
- Contact
- Authors
- Licence
- Acknowledgments
- References
The wolrd best project's description is about to be written here
You can find here, more information about what the final product should look like
Hey, check the ROADMAP.md file to know everythings about how are we going to do
See the open issues for a list of proposed features.
Any dependencies should go here, maybe better empty
Hopefully, this should be empty too
See the open issues for a list of known issues.
This is an example of how to list things you need to use the software and how to install them.
sudo apt-get update && sudo apt-get upgrade -y # Update your old computergit clone https://github.com/thdelmas/better-readme # Fetch source files
How does someone test the code ?
cd better-readme # Go in this famous directory
vim README.md # Open the file with my favorite text editor
#<ESC>:wq -> To quit vim
How does someone use the code ?
cp *.md ~/myprojectisbetter/ # copy all md files you need to your project
You can find API documentation at API.md
How can you help ?
What are the guidelines to follow?
Please check the CONTRIBUTING.md file
- thdelmas - Initial design
See also the list of contributors who participated in this project.
License - see the LICENSE file for details
Thanks to:
- All people spending their time to make a better world