readme-generator-0.1.3 is not a library.
What it does:
- Run the command in your project's directory
- it will ask a few questions
- You answer the questions
- It will generate a README for you, and will also add auto-generated installation and usage instructions
You can then edit the README yourself as you like!
Installation
If you want to use it, (and not bother with code), use this command:
cargo install readme-generator
If you don't have cargo, you can download the latest release This isn't recommended, because it won't be registered as a binary and you'll have to run the exe file
For contributing:
git clone https://github.com/Dhravya/readme-generator.git
cd Readme Generator
cargo install
Usage
readme-generator.exe
Then all you have to do is fill a form!
Normally, you'd run cargo run but that isn't needed because i've published to crates.io
License
This project is licensed under the MIT license
Show your support
Leave a ⭐ if you like this project
Readme made with 💖 using README Generator by Dhravya Shah