Commit c840719c authored by mrodzis's avatar mrodzis 🌎
Browse files

docs: Update README.md

parent f29ae1ac
......@@ -7,6 +7,10 @@ The viewer can be reached at <https://ahikar.sub.uni.goettingen.de>.
It is integrated during the build of the backend, cf. <https://gitlab.gwdg.de/subugoe/ahiqar/backend#get-the-frontend>.
## Project Configuration
The project specific configuration of the viewer is done in `index.html`. This file replaces TIDO's default settings in `index.template.html`. The replacement is done in the CI.
## Text Styling
To add a specific styling of the text in accordance with the project's requirements a
......@@ -23,7 +27,15 @@ You do not have to track the copied files in the version control system.
## Auto-update
### Upstream
The submodule Qviewer (= TIDO) will receive updates from its upstream project automatically.
The pipeline will be triggered by the upstream and passes the necessary upstream commit SHA.
For convinence we MAY add a manual job trigger in the upstream repository.
The upstream currently is: [subugoe/emo/Qviewer](https://gitlab.gwdg.de/subugoe/emo/Qviewer).
\ No newline at end of file
The upstream currently is: [subugoe/emo/Qviewer](https://gitlab.gwdg.de/subugoe/emo/Qviewer).
### Downstream
Each time a commit is done on `develop`, this repository's CI triggers a new pipeline on
the back end repository's `develop` branch so that the changes in the viewer are visible
shortly after.
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment