https://github.com/Dhravya/readme-generator

A very easy-to-use README generator that works in your terminal. Never stress about readme again!
https://github.com/Dhravya/readme-generator

readme readme-generator rust rust-lang

Last synced: 17 days ago
JSON representation

A very easy-to-use README generator that works in your terminal. Never stress about readme again!

• Host: GitHub
• URL: https://github.com/Dhravya/readme-generator
• Owner: Dhravya
• Created: 2022-03-03T07:34:33.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2022-03-17T08:32:38.000Z (over 2 years ago)
• Last Synced: 2024-11-17T11:57:15.948Z (25 days ago)
• Topics: readme, readme-generator, rust, rust-lang
• Language: Rust
• Homepage: https://blog.dhravya.dev/readme-generator/
• Size: 2.75 MB
• Stars: 47
• Watchers: 4
• Forks: 7
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml

Awesome Lists containing this project

• project-awesome - Dhravya/readme-generator - A very easy-to-use README generator that works in your terminal. Never stress about readme again! (Rust)

README

        


Welcome to Readme Generator




A simple, fast, easy README generator. Never worry about READMEs again!



---

![Readme Generator](https://us-east-1.tixte.net/uploads/img.dhravya.dev/l0ap2hcs50a.png)

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](https://github.com/Dhravya/readme-generator/releases)

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

windows:

```

readme-generator.exe

```

Linux:

```

#give it permission to run

chmod +x readme-generator

#run it

readme-generator

```

Mac:

coming soon

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

you can run `cargo build` to build the project for your os with rust compiler(You must have the source files)

### 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](https://github.com/Dhravya/readme-generator)