Getting Started

These installation commands are currently written for linux only. They should also work on Mac-OS but no guaranty.

• Getting Started
  • Dependencies
  • Getting the Repository
  • Project Setup
  • Testing the installation
• Full Commands

Here is a detailed step-by-step guide. If you know a bit more and want to skip the explanations you can go directly to the full commands

Dependencies

bash

git/wget/curl

python3 (3.7+)

python-pip

python-venv

Check which tool is available to get the repository. git is recommended but the others are also possible.

# check what of git/wget/curl is installed
$ which {git,wget,curl}
/usr/bin/git
/usr/bin/wget
/usr/bin/curl

Check the python version. It should be 3.7+

$ python3 -V
Python 3.10.12

Check if pythons package manager is available.

$ python3 -c 'import pip' && python3 -m pip -V
pip 23.1.2 from /home/user/.local/lib/python3.10/site-packages/pip (python 3.10)

If the message is some form of error (ModuleNotFoundError) Then you can run python3 -m ensurepip

Check if it’s possible to create a virtual-environment.

$ python3 -c 'import venv' && echo "venv available"
venv available

Otherwise, you have to install the system package (sudo apt install python3-venv) or another virtual-environment tool (pip3 install virtualenv)

Getting the Repository

Select one of the following

git clone https://github.com/PlayerG9/TermDocs.git

wget -q https://github.com/PlayerG9/TermDocs/archive/refs/heads/main.zip && unzip -q main.zip && rm main.zip && mv TermDocs-main TermDocs

curl -sLJo main.zip https://github.com/PlayerG9/TermDocs/archive/refs/heads/main.zip && unzip -q main.zip && rm main.zip && mv TermDocs-main TermDocs

Or download and unzip the zip from GitHub yourself.

Project Setup

First we will go into the Project folder

cd TermDocs

In order to not pollute your system-python environment we will use a virtual one.

# With pythons builtin venv:
python3 -m venv .venv
# With pip installable virtualenv
python3 -m virtualenv .venv

Afterward, we will install the dependencies.

./.venv/bin/pip3 install -U pip
./.venv/bin/pip3 install -U -r requirements.txt 

Testing the installation

./termdocs docs/

which should open this documentation in the terminal.

Full Commands

git clone https://github.com/PlayerG9/TermDocs.git
cd TermDocs
python3 -m venv .venv
./.venv/bin/pip3 install -U pip 
./.venv/bin/pip3 install -U -r requirements.txt