From 5a334966b56081070253014091dd1a07ea3cf5c6 Mon Sep 17 00:00:00 2001
From: waldek <waldek@mailbox.org>
Date: Tue, 25 May 2021 21:34:28 +0200
Subject: [PATCH] adds installation instructions to the readme

---
 readme.md | 31 +++++++++++++++++++++++++++++--
 1 file changed, 29 insertions(+), 2 deletions(-)

diff --git a/readme.md b/readme.md
index e042dc8..e9873bf 100644
--- a/readme.md
+++ b/readme.md
@@ -8,11 +8,38 @@ The `./poc_standalone.py` is a **proof of concept** on how the end program shoul
 It *kind* of works but there is a lot to fix and improve.
 The `./standalone_tui.py` is a basic [MVC](https://realpython.com/the-model-view-controller-mvc-paradigm-summarized-with-legos/) implementation we can build on.
 
-## Branches
+
+## Installation
+
+To install and use this package you'll need to install [pip](https://pip.pypa.io/en/stable/installing/).
+The easiest way to do this in Debian is via `apt`.
+Pip can be installed with `sudo apt install python3-pip`.
+On windows your mileage may vary.
+Once this is done, you can install the requirements via the following command, `pip install -r requirements.txt`, from within the cloned folder.
+
+The full process is as follows:
+
+```bash
+sudo apt install python3-pip
+git clone https://gitea.86thumbs.net/waldek/ccpq.git
+cd ccpq
+pip install --user -r requirements.txt
+```
+
+## Development
 
 All development should be done in the `testing` branch and brought to the `master` branch with merge requests.
 
+## Usage
 
-## Standalone TUI
+There are multiple scripts you can run in this repo.
+
+### Standalone TUI
+
+This is the `standalone_tui.py` file.
+You should run it from a terminal and it requires at lease a path to a CSV file to use as database.
+Try `python3 standalone.py --help` for more information.
 
 ![screenshot](./assets/screenshot_1.png)
+
+