gen-readme
| Crates.io | gen-readme |
| lib.rs | gen-readme |
| version | 1.0.1 |
| created_at | 2023-07-21 20:06:29.725944+00 |
| updated_at | 2023-08-30 17:29:12.06063+00 |
| description | Just a simple readme generator that uses a static templates. |
| homepage | https://crates.io/crates/gen-readme |
| repository | https://github.com/datsfilipe/gen-readme |
| max_upload_size | |
| id | 922626 |
| size | 42,904 |
Filipe Lima (datsfilipe)
documentation
README
gen-readme
A readme generator. Well, trully? it just copies the template to your directory.
Usage
Install the package globally:
- With
cargo:
cargo install gen-readme
- With
AUR helper (yay):
yay -S gen-readme-bin
- With
AUR helper (paru):
paru -S gen-readme-bin
How to Run the Project
- Clone this repository:
git clone git@github.com:datsfilipe/gen-readme.git. - Enter in the project directory:
cd gen-readme. - Run the project:
cargo run.
How to Contribute
Follow these steps to contribute to the project:
- Fork the repository.
- Create a new branch:
git checkout -b feature-branch-name. - Make your changes and commit them:
git commit -m 'Add some feature'. - Push to the branch:
git push origin feature-branch-name. - Open a pull request.
Please ensure that your code adheres to the project's coding standards.
Contributors
 Filipe Lima |
License
This project is licensed under the License.