gen_readme is tool for creating README.md doc module.

Developed in python code.

The README is used to introduce the modules and provide instructions on how to install the modules, any machine dependencies it may have and any other information that should be provided before the modules are installed.

Table of Contents

• Installation
  • Install using pip
  • Install using setuptools
  • Install using docker
• Dependencies
• Tool structure
• Docs
• Copyright and Licence

Currently there are three ways to install tool

• Install process based on pip
• Install process based on setup.py (setuptools)
• Install process based on docker mechanism

Python package is located at pypi.org.

You can install by using pip

#python2
pip install gen_readme
#python3
pip3 install gen_readme

Navigate to release page download and extract release archive.

To install modules, locate and run setup.py, type the following

tar xvzf gen_readme-x.y.z.tar.gz
cd gen_readme-x.y.z
#python2
pip install -r requirements.txt
python setup.py install_lib
python setup.py install_egg_info
python setup.py install_data
#python3
pip3 install -r requirements.txt
python3 setup.py install_lib
python3 setup.py install_egg_info
python3 setup.py install_data

You can use Dockerfile to create image/container.

gen_readme requires next modules and libraries

• ats-utilities - Python App/Tool/Script Utilities

gen_readme is based on OOP

Generator structure

gen_readme/
├── conf/
│   ├── gen_readme.logo
│   ├── gen_readme.cfg
│   ├── gen_readme_util.cfg
│   ├── project.yaml
│   └── template/
│       ├── README_AVR.template
│       ├── README_CC.template
│       ├── README_C.template
│       ├── README_JS.template
│       ├── README_PL.template
│       ├── README_PY.template
│       ├── README_RPI.template
│       ├── README_SH.template
│       ├── README_STM.template
│       └── README_VALA.template
├── __init__.py
├── log/
│   └── gen_readme.log
├── pro/
│   ├── __init__.py
│   ├── read_template.py
│   └── write_template.py
└── run/
    └── gen_readme_run.py

More documentation and info at

• gen_readme.readthedocs.io
• www.python.org

Copyright (C) 2020 by vroncevic.github.io/gen_readme

gen_readme is free software; you can redistribute it and/or modify it under the same terms as Python itself, either Python version 2.x/3.x or, at your option, any later version of Python 3 you may have available.

Lets help and support PSF.