# gen-readme
A readme generator. Well, trully? it just copies the template to your directory.
[](https://github.com/datsfilipe/gen-readme/stargazers)
## Usage
Install the package globally:
- With `cargo`:
```bash
cargo install gen-readme
```
- With `AUR helper (yay)`:
```bash
yay -S gen-readme-bin
```
- With `AUR helper (paru)`:
```bash
paru -S gen-readme-bin
```
## How to Run the Project
1. Clone this repository: `git clone git@github.com:datsfilipe/gen-readme.git`.
2. Enter in the project directory: `cd gen-readme`.
3. Run the project: `cargo run`.
## How to Contribute
Follow these steps to contribute to the project:
1. Fork the repository.
2. Create a new branch: `git checkout -b feature-branch-name`.
3. Make your changes and commit them: `git commit -m 'Add some feature'`.
4. Push to the branch: `git push origin feature-branch-name`.
5. Open a pull request.
Please ensure that your code adheres to the project's coding standards.
## Contributors
## License
This project is licensed under the [License](LICENSE).
