Create README.md doc module¶
gen_readme is tool for creating README.md doc module.
Developed in python code: 100%.
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.
Installation¶
Navigate to release page download and extract release archive.
To install this set of modules type the following
tar xvzf gen_readme-x.y.z.tar.gz
cd gen_readme-x.y.z/
# python3
wget https://bootstrap.pypa.io/get-pip.py
python3 get-pip.py
python3 -m pip install --upgrade setuptools
python3 -m pip install --upgrade pip
python3 -m pip install --upgrade build
pip3 install -r requirements.txt
python3 -m build --no-isolation --wheel
pip3 install ./dist/gen_readme-*-py3-none-any.whl
rm -f get-pip.py
chmod 755 /usr/local/lib/python3.10/dist-packages/usr/local/bin/gen_readme_run.py
ln -s /usr/local/lib/python3.10/dist-packages/usr/local/bin/gen_readme_run.py /usr/local/bin/gen_readme_run.py
You can use Docker to create image/container, or You can use pip to install
#python3
pip3 install gen_readme
Dependencies¶
gen_readme requires next modules and libraries
Tool structure¶
gen_readme is based on OOP
Code structure
gen_readme/
├── conf/
│ ├── gen_readme.cfg
│ ├── gen_readme.logo
│ ├── 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
6 directories, 20 files
Copyright and licence¶
Copyright (C) 2020 - 2024 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 3.x or, at your option, any later version of Python 3 you may have available.
Lets help and support PSF.
