This content originally appeared on DEV Community and was authored by DEV Community
I'm the type of person who keeps creating different repositories and small open-source projects.
One major problem I was having was, making the README files would be so boring :(
After completing the monkeytype bot project, I had to write a README for it. Like any other programmer, instead of taking 5 minutes to write the readme, I spent the next 2 hours automating the same - in Rust.
I was looking for a good, useful, but easy project to practice and polish my Rust skills, and this was the perfect idea, since it’s so useful for me.
So here it is! The README generator
Here's the project on github:
If you want to read about the process of making it, read my blog post here - https://blog.dhravya.dev/readme-generator/
I didn't publish it to dev.to because, honestly, most people would find it boring lol
How to use it
If you have cargo installed, it's remarkably easy to install and use-
cargo install readme-generator
readme-generator.exe
That's it!
If you don't have cargo installed, you'll have to download the exe file from github here: https://github.com/Dhravya/readme-generator/releases
Please leave your feedback here on how I can improve this project and if you used it, leave a ⭐ on Github and comment on this post!
This content originally appeared on DEV Community and was authored by DEV Community
DEV Community | Sciencx (2022-03-06T10:33:16+00:00) Create README files for your project in 30 seconds ⚡. Retrieved from https://www.scien.cx/2022/03/06/create-readme-files-for-your-project-in-30-seconds-%e2%9a%a1/
Please log in to upload a file.
There are no updates yet.
Click the Upload button above to add an update.