A simple, fast, easy README generator

Dhravya Shah

Last update: Nov 13, 2022

Overview

Welcome to Readme Generator

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

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

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

Quad-rand implements pseudo-random generator

quad-rand quad-rand implements pseudo-random generator based on rust atomics. Compatible with wasm and any oth

10 Feb 11, 2022

⚙️ A cute .gitignore generator with support for custom templates

Gign A Gitignore Generator Table of Contents Examples Install Custom templates Help Examples # This is how you going to use it probably most of the ti

6 Dec 7, 2022

Nexmark event generator in Rust.

Nexmark-rs The Nexmark benchmark data generator in Rust. Installation cargo install nexmark --features bin Usage Generate nexmark events. Print one pe

11 Nov 27, 2022

A code generator to reduce repetitive tasks and build high-quality Rust libraries. 🦀

LibMake A code generator to reduce repetitive tasks and build high-quality Rust libraries Welcome to libmake 👋 Website • Documentation • Report Bug •

27 Mar 12, 2023

A dynamic image generator.

dynimgen A dynamic image generator. How to use step 1: The designers export the design drawing as an svg file svg rect / image src="img.png"

29 Jun 14, 2023

waveplot is a VCD waveform generator for the terminal.

waveplot waveplot is a VCD waveform generator for the terminal. Installation (dev) Install the Rust compiler 'rustc' using rustup. curl --proto '=http

2 Jul 12, 2023

Pure rust implementation of python's random module with compatible generator behaviour.

pyrand Pure rust implementation of (parts of) python's random module with compatible PRNG behaviour: seeding with equivalent values will yield identic

4 Feb 10, 2024

Easy switch between AWS Profiles and Regions

AWSP - CLI To Manage your AWS Profiles! AWSP provides an interactive terminal to interact with your AWS Profiles. The aim of this project is to make i

14 Dec 25, 2022

Easy to use Rust i18n library based on code generation

rosetta-i18n rosetta-i18n is an easy-to-use and opinionated Rust internationalization (i18n) library powered by code generation. rosetta_i18n::include

38 Dec 18, 2022

Comments

Added project logo feature and typehinted stuff
please ignore the first commit

What I added

typehinting where it was not obvious

added a feature for project logo

the user has to enter an image url, the logo will show up after the below the heading, center aligned

the height and width will be 80

bumped version to 0.1.2

resolved merge conflicts
opened by nexxeln 0
fixed the `cd` directory generation

Currently, the directory is generated using the filepath of the current directory. It would be better if it automatically gets the repository name (tries to) and uses that instead (because that's what github does, it pulls into the same directory as repo name)

opened by Dhravya 0

Releases(0.1.2)

0.1.2(Mar 4, 2022)

This is a stable .exe file of the generator. While it's recommended to use the cargo package instead, this might be useful for people who don't have cargo and just want to try it out. IMPORTANT : This will only work if you directly run the file itself, it's recommended to put this file in the bin folder
Source code(tar.gz)
Source code(zip)
readme-generator.exe(295.50 KB)