A simple, fast, easy README generator

Related tags

Utilities rust readme rust-lang readme-generator
Overview

Welcome to Readme Generator

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

Readme Generator

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

You might also like...
Quad-rand implements pseudo-random generator

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

Fedor Logachev 10 Feb 11, 2022
⚙️ A cute .gitignore generator with support for custom templates
⚙️ 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

Vadim 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

RisingWave Labs 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 •

Sebastien Rousseau 27 Mar 12, 2023
A dynamic image generator.
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"

null 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

Suhas Kudlur Viswanath 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

Stefan V. 4 Feb 10, 2024
Simple and fast git helper functions

Simple and fast git helper functions

LongYinan 126 Dec 11, 2022
A simple *blazingly fast* Rust library to unzip an S3 archive without downloading.

S3-unzip A simple blazingly fast Rust library to unzip an S3 archive into S3's root directory. Works without downloading the archive or putting it int

Mykhailo Bondarenko 9 Jul 12, 2022
Comments
  • Added project logo feature and typehinted stuff

    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

    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)
Owner
Dhravya Shah
Hi, I'm Dhravya (aka SpaceDoggo) ! 👋 I am a 16 year old interested in software development. I am mainly specialised in Python, javascript and tailwindcss
Dhravya Shah
GitHub https://blog.dhravya.dev/readme-generator/
Czkawka is a simple, fast and easy to use app to remove unnecessary files from your computer.

Multi functional app to find duplicates, empty folders, similar images etc.

Rafał Mikrut 9.2k Jan 4, 2023
A simple code boilerplate generator written in Rust.

?? Cgen What is Cgen? A modern, cross-platform, multi-language boilerplate generator aimed to make your code generation less hectic! If you wish to su

Rithul Kamesh 1 Dec 25, 2021
A simple quote-based code generator for Rust

flexgen A flexible, yet simple quote-based code generator for creating beautiful Rust code Why? Rust has two types of macros, and they are both very p

Scott Meeuwsen 11 Oct 13, 2022
Dead simple, minimal SPDX License generator library written in Rust.

lice Dead simple, minimal SPDX License generator library written in Rust. Lice is in beta Install | User Docs | Crate Docs | Reference | Contributing

refcell.eth 9 Oct 22, 2023
Build your service-server fast, easy (and without hosting!)

service-io is a library to build servers that offering services with really little effort. Choose an input connector. Choose an output connector. Choo

Luis Enrique Muñoz Martín 34 Jan 4, 2023
A stupidly simple and easy to self-host, personal server for file hosting on the web

Grasswave CDN A stupidly simple and easy to self-host, personal server for file hosting on the web. Written in Rust. Thanks, @Maciejowski, for the sty

Rafał Baran 3 Jan 3, 2023
🦀 Rust-based implementation of a Snowflake Generator which communicates using gRPC

Clawflake Clawflake is a Rust application which implements Twitter Snowflakes and communicates using gRPC. Snowflake ID numbers are 63 bits integers s

n1c00o 5 Oct 31, 2022
Universal changelog generator using conventional commit+ with monorepo support. Written in Rust.

chlog Universal changelog generator using conventional commit+ with monorepo support. chlog can generate the changelog from the conventional commits w

Jeff Yang 3 Nov 27, 2022
Boot tools: loader, image generator, etc as a library crate

ArcBoot v0 A uefi bootloader for riscv, arm and x86. Comes in the form of a single executable. the source code contains a single executable target and

Spectral Project 3 Oct 3, 2022
Flexible snowflake generator, reference snoyflake and leaf.

Flexible snowflake generator, reference snoyflake and leaf.

Egccri 2 May 6, 2022