From 5ea3dab15093805164f9086e081a3ba1b2efac9b Mon Sep 17 00:00:00 2001 From: Natanael Arndt Date: Tue, 14 Mar 2023 15:15:18 +0100 Subject: [PATCH] Update README, add some development instructions --- CHANGELOG.md | 2 +- README.md | 18 ++++++++++++++++++ 2 files changed, 19 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 2932c69..578c808 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -19,7 +19,7 @@ TODO: add at least one Added, Changed, Deprecated, Removed, Fixed or Security se ### Changed -- +- Update README, add some development instructions ## [0.2.0] 2023-01-31 diff --git a/README.md b/README.md index 8419dcf..a8e6643 100644 --- a/README.md +++ b/README.md @@ -72,6 +72,24 @@ If you are running your CMEM orchestration locally you need to connect cmemc to To achieve that create a file called `.env` in your repository. In it define the variable `CMEMC_DOCKER_PARAMS="-v $PWD/cmemc.ini:/cmemc.ini --network conmtainer:"`, where `` is the container id of the apache2 container in your cmem orchestration. +## Development Setup + +To get a development setup you need to checkout this `ontology-pipeline-template` repository and create a second repository with an ontology using the copier template. +To initialize your ontology repository with your build environment run. +``` +copier --vcs-ref HEAD path/to/template/repository path/to/ontology/repository +``` + +To simply switch your ontology repository to the latest development state of this repository run + +``` +copier --vcs-ref main update +# or +copier --vcs-ref HEAD update +``` + +To switch the remote template repository check out [Trouble shooting](#trouble-shooting) > [Migrate from a different template remote](#migrate-from-a-different-template-remote). + ## TODO - Initial generation of turtle files - How to deal with `.gitignore` and similar files updated and used by multiple tools