README Generator

Overview

Generate README.md files effortlessly using this lightweight command line utility. While it includes several default templates, its strength lies in its ability to work with your own custom templates.

Using Custom Templates:

1. Create a directory named readme-templates inside the Documents folder of your operating system (or specify a different directory using --template-dir argument).

2. Add your markdown templates to this directory.

3. At the beginning of each template, specify placeholders by adding a line like Placeholders: [placeholder_name_1],[placeholder_name_2]. Avoid spaces between placeholders.

   For instance: Placeholders: [project_name],[author_name]

When you use the tool, it will prompt you to input values for each of these placeholders. The tool will then replace all occurrences of the placeholders throughout the file with your input.

A few things to note:

• Placeholders are Optional: You can choose to include them or not.
• No Spaces in Placeholder List: Ensure there's no space between the placeholders you list.

If you would like to see some examples, check the templates folder.

Tip: To make a section in your template optional, simply prefix its heading with ?. For example, ## ?Contributing denotes an optional "Contributing" section.

Installation

Using cargo

cargo install generate-readme

From source

git clone https://github.com/jacobschwantes/generate-readme.git
cd generate-readme
cargo install --path .

Usage

generate-readme

# To use a path to custom templates other than the default ~/Documents/readme-templates
generate-readme --template-dir path/to/custom/templates

Contributing

Fork the repository Create a branch

git checkout -b fix/amazingFix

Commit your changes and push to your branch

git commit -m "made an amazingFix"
git push origin fix/amazingFix

Open a pull request