How many hours or minutes do you spend to create a new Readme for a project?
I think too much or too less.
A good Readme file for a project it's a like a business card of you and for you have built.
The last week I spent few hours to create a tool for creating a really simple README file directly from your machine.
It's a dotnet tool that you can install from NuGet.
Installation
Install readme-generator with NuGet as global tool
dotnet tool install --global readme-generator
How to use it
As a global dotnet tool, after the installation, you can launch the tool with the following command:
readme-generator
Contributing
The tool is opensource and contributing is really welcome to add some parts on the markdown file. :)
kasuken
/
readme-generator
A simple README generator.
README generator
Create a simple README for your next project in 5 seconds
Installation
Install readme-generator with NuGet as global tool
dotnet tool install --global readme-generator
How to use it
As a global dotnet tool, after the installation, you can launch the tool with the following command:
readme-generator
Run Locally
Clone the project
git clone https://github.com/kasuken/readme-generator
Go to the project directory
cd readme-generator
Install dependencies
dotnet run
Demo
Tech Stack
- .NET 6
- C# 10
- NuGet
- GitHub Actions
Contributing
Contributions are always welcome!
Top comments (2)
Thanks!
Wow! Great job!
Looks like it's the same thing as my readme generator (even the text is same, xD) but in c#!! Could've mentioned it tbh, but it's fine lol
anyways, really good project 👍🏻
Some comments have been hidden by the post's author - find out more