From 9dbb366395686c3ba874f944351d97efbff2b969 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Henrik=20tom=20W=C3=B6rden?= <h.tomwoerden@indiscale.com>
Date: Mon, 14 Dec 2020 14:14:50 +0100
Subject: [PATCH] DOC: include README_SETUP
---
README_SETUP.md | 50 ++++++++++++++++++++++++--------------
src/doc/getting_started.md | 18 --------------
src/doc/index.rst | 2 +-
3 files changed, 33 insertions(+), 37 deletions(-)
delete mode 100644 src/doc/getting_started.md
diff --git a/README_SETUP.md b/README_SETUP.md
index 7d4cce6e..b9db16a9 100644
--- a/README_SETUP.md
+++ b/README_SETUP.md
@@ -1,16 +1,35 @@
+# Getting started
-# Installation
-pip install . --user
-pip install tox --user
+## Download
+The recommended way is:
+```
+# Clone the repository:
+git clone 'https://gitlab.com/caosdb/caosdb-advanced-user-tools'
+```
+
+## Dependencies
+Dependencies will be installed automatically if you use the below described procedure.
+- `caosdb>=0.4.0`
+- `openpyxl>=3.0.0`
+- `xlrd>=1.2.0`
+
+For testing:
+- `tox`
+- `scifolder`from https://gitlab.com/henrik_indiscale/scifolder
+
+
+## Installation
+- `pip install . --user`
+- `pip install tox --user`
In order to run the tests you need to install the [scifolder
package](https://gitlab.com/henrik_indiscale/scifolder) by Henrik tom
Wörden.
-# Run Unit Tests
-tox
+## Run Unit Tests
+`tox`
-# Run Integration Tests Locally
+## Run Integration Tests Locally
1. Change directory to `integrationtests/`.
2. Mount `extroot` to the folder that will be used as
@@ -22,20 +41,15 @@ tox
an empty insctance.
4. Run `test.sh`.
-# Code Formatting
-autopep8 -i -r ./
-
-# Dependencies
-
-test:
-- scifolder package from https://gitlab.com/henrik_indiscale/scifolder
+## Code Formatting
+`autopep8 -i -r ./`
-# Documentation #
+## Documentation #
Build documentation in `build/` with `make doc`.
-## Requirements ##
+### Requirements ##
-- sphinx
-- sphinx-autoapi
-- recommonmark >= 0.6.0
+- `sphinx`
+- `sphinx-autoapi`
+- `recommonmark >= 0.6.0`
diff --git a/src/doc/getting_started.md b/src/doc/getting_started.md
deleted file mode 100644
index 97dc1d28..00000000
--- a/src/doc/getting_started.md
+++ /dev/null
@@ -1,18 +0,0 @@
-# Getting started with pycaosdb #
-
-## Installation
-The program can be installed (under Linux) with:
-```
-# Clone the repository:
-git clone 'https://gitlab.com/caosdb/caosdb-advanced-user-tools'
-
-# cd into the directory:
-cd caosdb-advanced-user-tools
-
-# Use pip to install the package:
-pip install --user .
-```
-
-## import
-
-## enjoy
diff --git a/src/doc/index.rst b/src/doc/index.rst
index 046ec3ab..ee266598 100644
--- a/src/doc/index.rst
+++ b/src/doc/index.rst
@@ -11,7 +11,7 @@ This documentation helps you to :doc:`get started<getting_started>`, explains th
:maxdepth: 2
:caption: Contents:
- Getting started <getting_started>
+ Getting started <README_SETUP>
Concepts <concepts>
tutorials
Caosdb-Crawler <crawler>
--
GitLab