README-generator

A simple readme generator
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• License
• Contact
• Acknowledgements

About The Project

This readme was generated using the project

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

All you need is bash with gnu utilities

Installation

1. Clone the README-generator

git clone https://github.com/F0xedb/README-generator.git

2. Install packages

chmod +x readme-gen
cp readme-gen /usr/bin
mkdir -p .cache/readme
cp demo .cache/readme/demo

Alternatively arch users can do the following

yay -Syu readme-gen

Usage

Simply run

readme-gen

And answer all questions. It will generate the readme file in the current dir.

config

Alternatively you can use a config file and based on that generate a readme.

readme-gen -c config

The config file will look something like this

#example config file for the readme generator

# Set the theme to generate from
# If it is not specified the theme will be "demo"
theme="demo"

# General settings. These must be present in this config otherwise they will be empty in the final result
repo="README-generator" # this will autofill to https://www.github.com/F0xedb/README-generator inside the readme template
org_name="F0xedb"
usr_name="$org_name" # You can reference other variables like this
usr_email="tom@odex.be"

title="README generator"
desc="A simple readme generator"

doc="https://www.pbfp.xyz"

license="GPL"

image_url="https://tos.pbfp.xyz/images/logo.svg"
width="150" # width of the image in pixels
height="200" # height of the image in pixels

This is the example used for generating this readme.

templates

To add a readme template to this tool use the following

readme-gen --add template

The template works as followed. All variables are used in this simple example

<a href="https://github.com/org_name/repo">
   <img src="image_url" alt="Logo" width="width_img" height="height_img">
</a>

# title_var
desc_var

## extra

build by
usr_name - usr_email

repo is build using license_var

_more info refer to the [Documentation](doc_var)

You can also list all the current existing theme and also tell the tool which theme to use

readme-gen --list # this lists all the known templates
readme-gen --theme <template> # the readme will be generated using the <template> theme

For more examples, please refer to the Documentation

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the GPL License. See LICENSE for more information.

Contact

Tom Meyers - tom@odex.be

Project Link: https://github.com/F0xedb/README-generator