🏠 Homepage
Readme Maker is a simple application to help you to make your README files
Before you begin, ensure you have met the following requirements:
- If you install it from PPA don't worry about, becouse all the requirements are included in the package
- If you clone the repository, you need, at least, these dependecies,
gir1.2-gtk-3.0
gir1.2-glib-2.0
gir1.2-gdkpixbuf-2.0
gir1.2-appindicator3-0.1
gir1.2-keybinder-3.0
To install Readme Maker, follow these steps:
- In a terminal (
Ctrl+Alt+T), run these commands
sudo add-apt-repository ppa:atareao/atareao
sudo apt update
sudo apt install readmemaker
When you start Readme Maker it show the folloging dialog4
In this main screen you can see 7 sections. First section is General, where you can fill the main parameters for your project. The Title of the project, the GitHub project, the license of the project, and others.
The second section is description, where you can introduce to the user the objective of your application. A short description.
The prerequisistes are in the third section where you must talk about the dependencies for your project.
After that, in the four section, you must tell how to install your project, so the user can enjoy with it.
Maybe, the fifth section is the most important, becouse is the place where you tell how to use your proyect.
Another important section is the sixth section, where you specify how every one can contribute to this project
Y at last a mention for everyone that contributed to this project
The information about contributors from GitHub
To contribute to Readme Maker, follow these steps:
- Fork this repository.
- Create a branch:
git checkout -b <branch_name>. - Make your changes and commit them:
git commit -m '<commit_message>' - Push to the original branch:
git push origin atareao/readmemaker - Create the pull request.
Alternatively see the GitHub documentation on creating a pull request. </project_name></commit_message></branch_name>
Thanks goes to these wonderful people (emoji key):
|
| Lorenzo |
| 💻 |