From 4b282de98796875fdd05206f77ae51918bb279db Mon Sep 17 00:00:00 2001 From: Jan Grewe Date: Wed, 18 Sep 2019 22:59:38 +0200 Subject: [PATCH] more docu --- docs/index.md | 29 +++++++++++++++++------------ 1 file changed, 17 insertions(+), 12 deletions(-) diff --git a/docs/index.md b/docs/index.md index c1a83b7..3194ba7 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,9 +1,9 @@ # How to use the fish book ## Requirements -* Python3.5+ only +* Python 3.5+ only, **no** python 2 * [datajoint](https://datajoint.io) to connect to the database and to map python objects to table entries. -* [nixio](https://github.com/g-node/nixpy) to read the relacs-flavored nix files +* [nixio](https://github.com/g-node/nixpy) to read the relacs-flavored nix files during import or later during data retrieval. ## Installation @@ -11,20 +11,25 @@ 1) clone the repository ``` -git clone https://whale.am28.uni-tuebingen.de/git/jgrewe/fishbook.git . +>> git clone https://whale.am28.uni-tuebingen.de/git/jgrewe/fishbook.git ``` -2) installation -..a) for development, install for the current user, install as "editable" - ```Shell - cd fishbook - pip3 install fishbook -e --user +2. installation + When installing for development: install for the current user, install as "editable": + ``` - b) just for usage + >> cd fishbook + >> pip3 install fishbook -e --user ``` - pip3 install fishbook --user + + When installing for use: + + ``` + >> pip3 install fishbook --user # or - sudo pip3 install fishbook + >> sudo pip3 install fishbook ``` -3) connecting to the database \ No newline at end of file +3. connecting to the database + + Suppose that you intend to work on a project named `foo` use the terminal to navigate to the project directory: `cd foo` \ No newline at end of file