Commit 452fc297 authored by mrodzis's avatar mrodzis 🐸
Browse files

docs(readme.md): explain the interconnection of QViewer and Ahiqar

parent 58638cbe
# Emo Viewer (viewer) # EMo Viewer
Viewer for the modular framework to present digital editions. Viewer for the modular framework to present digital editions.
**Note:**
Although the EMo Viewer is designed as a generic viewer for digital editions, it is currently developed within the scope of the [Ahiqar project](https://gitlab.gwdg.de/subugoe/ahiqar).
This is the reason for "Ahiqar" being mentioned several times in the docs of this repo.
Demo: https://subugoe.pages.gwdg.de/emo/Qviewer/develop Demo: https://subugoe.pages.gwdg.de/emo/Qviewer/develop
(for newer branches the demo is deployed in a directory named with branch name lowercased, shortened to 63 bytes, and with everything except `0-9` and `a-z` replaced with `-` (CI_COMMIT_REF_SLUG). Also the commit short hash can be used to see a demo. (For newer branches the demo is deployed in a directory named with branch name lowercased, shortened to 63 bytes, and with everything except `0-9` and `a-z` replaced with `-` (CI_COMMIT_REF_SLUG).
Also the commit short hash can be used to see a demo.
## Getting Started ## Getting Started
...@@ -59,10 +64,12 @@ See [Configuring quasar.conf.js](https://quasar.dev/quasar-cli/quasar-conf-js). ...@@ -59,10 +64,12 @@ See [Configuring quasar.conf.js](https://quasar.dev/quasar-cli/quasar-conf-js).
## Authors ## Authors
See the list of [contributors](https://gitlab.gwdg.de/subugoe/emo/Qviewer/-/graphs/develop) who participated in this project. See the list of [contributors](https://gitlab.gwdg.de/subugoe/emo/Qviewer/-/graphs/develop) who participated in this project.
Please notice our [contribution guidelines](CONTRIBUTING.md) which contains all necessary information about the development workflow.
## Dockerfile ## Dockerfile
The dockerfile is used at GitLab CI. It needs to be updated, when either node or quasar-cli should be updated. The dockerfile is used at GitLab CI.
It needs to be updated, when either node or quasar-cli should be updated.
``` ```
docker build --pull -t docker.gitlab.gwdg.de/subugoe/emo/qviewer/node . docker build --pull -t docker.gitlab.gwdg.de/subugoe/emo/qviewer/node .
docker push docker.gitlab.gwdg.de/subugoe/emo/qviewer/node docker push docker.gitlab.gwdg.de/subugoe/emo/qviewer/node
``` ```
Supports Markdown
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