diff --git a/src/doc/getting_started.md b/src/doc/getting_started.md index 6805181e73a7f338fbacb74bdd9f734360404372..4ed08b3541e7fa475da955247d5e4610eb4d404d 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*