From dd8d56da79719167f5c65f2b556bd77f0fa1129d Mon Sep 17 00:00:00 2001 From: Daniel <daniel@harvey> Date: Thu, 10 Dec 2020 10:41:54 +0100 Subject: [PATCH] DOC WIP: getting started --- src/doc/getting_started.md | 25 ++++++++++++++++++++++--- 1 file changed, 22 insertions(+), 3 deletions(-) diff --git a/src/doc/getting_started.md b/src/doc/getting_started.md index 6805181e..4ed08b35 100644 --- a/src/doc/getting_started.md +++ b/src/doc/getting_started.md @@ -1,5 +1,24 @@ # Getting started with pycaosdb # -1. Install -2. import -3. enjoy +## Installation ## + +### Requirements ### + +Pycaosdb needs at least Python 3.6. Additionally, the following packages are required (they will +typically be installed automatically): + +- `lxml` +- `PyYaml` +- `PySocks` + +### How to install ### + +To install pycaosdb locally, use `pip` (called `pip3` on some systems) in the top-level directory: + +```sh +pip3 install --user . +``` + +## - Install - import - enjoy ## + +*TODO* -- GitLab