readme-generator: a global dotnet tool for your next project

Emanuele Bartolesi - Mar 7 '22 - - Dev Community

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.

readme-generator

Installation

Install readme-generator with NuGet as global tool

  dotnet tool install --global readme-generator
Enter fullscreen mode Exit fullscreen mode

How to use it

As a global dotnet tool, after the installation, you can launch the tool with the following command:

  readme-generator
Enter fullscreen mode Exit fullscreen mode

Contributing

The tool is opensource and contributing is really welcome to add some parts on the markdown file. :)

GitHub logo kasuken / readme-generator

A simple README generator.

image

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
Enter fullscreen mode Exit fullscreen mode

How to use it

As a global dotnet tool, after the installation, you can launch the tool with the following command:

  readme-generator
Enter fullscreen mode Exit fullscreen mode

Run Locally

Clone the project

  git clone https://github.com/kasuken/readme-generator
Enter fullscreen mode Exit fullscreen mode

Go to the project directory

  cd readme-generator
Enter fullscreen mode Exit fullscreen mode

Install dependencies

  dotnet run
Enter fullscreen mode Exit fullscreen mode

Demo

4ff4ce0e-2cd0-4f2c-92b4-2c9e0cb77a56

Tech Stack

  • .NET 6
  • C# 10
  • NuGet
  • GitHub Actions

Contributing

Contributions are always welcome!

License

MIT

View on GitHub
Image
Angular Router URL Parameters Using NgRx Router Store

angular, ngrx, javascript, frontend
Image
How to keep your footer at the bottom of the page with Tailwind CSS

tailwindcss, tutorial
Image
How to rock a hoodie like a model

sp5der, stussyhoodie, stussy, sp5derhoodie
Image
Official Number How do I contact Coinme support by Phone? Easy Guide
Image
Ultimate Guide to Scrape Google Finance Using Python

webdev, python, programming, tutorial
Image
E-Rickshaw Advertising: A Green Solution for Modern Marketers

advertising, marketing
Image
Windows terminal commands

beginners, csharp, programming, backend
Image
How To Contact McAfee By Phone UK Support Get~Help
Image
How do I contact G𝐞mini ? USA~G𝐞mini Support Customer(Service)
Image
Penerjemah Kontrak
Image
SSL/TLS Handshake Explained: Process, Work and Importance

ssl, tls, sslhandshake, tlshan
Image
How To Contact McAfee Support Number UK ? [Expert Team]
Image
The Transformative Benefits of Automating Workday Testing

automating, workday, testing
Image
How E-Rickshaw Advertising Enhances Public Awareness Campaigns

marketing, advertising
Image
VidMate
Image
Final Application on Website
Image
Book Best Luxury Hotels in Ludhiana
Image
Mastering SQL: Best Practices for Developers

sql
Image
How Do Rag Pipelines Simplify Data Engineering for Data Scientists?

webdev, ai, database
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Terabox Video Player