From d1c9608260d0e03917bd1ef786641d1f706022d7 Mon Sep 17 00:00:00 2001 From: Yannick DAYER <yannick.dayer@idiap.ch> Date: Mon, 20 Mar 2023 15:22:26 +0100 Subject: [PATCH] docs [installation]: Review the development setup. Reorganize the commands summary. --- instructions/development_tldr.md | 30 ++++++++++++++++++++++++++---- 1 file changed, 26 insertions(+), 4 deletions(-) diff --git a/instructions/development_tldr.md b/instructions/development_tldr.md index b4019ef..d54309e 100644 --- a/instructions/development_tldr.md +++ b/instructions/development_tldr.md @@ -1,11 +1,33 @@ # Quick development setup -Here is an example of how to create a working development environment for -`bob.bio.face`: +## First time setup + +### Install idiap-devtools in base + +``` sh +conda activate +mamba install idiap-devtools +``` + +### Clone and set up bob/dev-profile + +_You can use any other directory instead of `~/idiap-dev-profiles`._ + +``` sh +git clone git@gitlab.idiap.ch/bob/dev-profile ~/idiap-dev-profiles/bob +echo '[profiles] +default = "bob" +bob = "~/idiap-dev-profiles/bob" +' > ~/.config/idiap-devtools.toml +``` + +## Create a dev environment (here for bob/bob.bio.face) ``` sh git clone git@gitlab.idiap.ch:bob/bob.bio.face.git -devtool env ./bob.bio.face -o bob_bio_face_env.yaml +cd ./bob.bio.face +devtool env --python=3.10 -o bob_bio_face_env.yaml . mamba env create -f bob_bio_face_env.yaml -n bob_face_devel -pip install --no-deps -e ./bob.bio.face +pip install --no-deps -e . +pre-commit install ``` -- GitLab