#aur #cli #readme-generator #gen #generator #cargo #assets

app gen-readme

Just a simple readme generator that uses a static templates

4 releases (2 stable)

1.0.1 Aug 30, 2023
0.1.1 Jul 21, 2023
0.1.0 Jul 21, 2023

#347 in Development tools

MIT license

180 lines


A readme generator. Well, trully? it just copies the template to your directory.

GitHub stars Repository Size Language Count Last Commit Version



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

  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.


Filipe's Photo
Filipe Lima


This project is licensed under the License.


~64K SLoC