Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

documentatie bijgewerkt #198

Merged
merged 1 commit into from
Nov 12, 2024
Merged

documentatie bijgewerkt #198

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ Meer informatie over de configuratie en de werking van de tool is te vinden in d

De tool is aan te roepen als docker container. Om de docker container lokaal uit te kunnen voeren moet Docker geïnstaleerd zijn op het lokale systeem en de repository lokaal beschikbaar zijn, vervolgens is de tool aan te roepen met het volgende commando:

Mac/Linux
```shell
docker run --rm \
--pull=always \
Expand All @@ -23,11 +24,13 @@ docker run --rm \
-v /$(pwd)/doc/gen/:/doc/gen ghcr.io/skemu/rdf-template:latest
```

(N.B.) Op het moment is dit alleen op MacOs/Linux getest.
Windows
```shell
docker run --rm --pull=always -v %cd%\config:/config -v %cd%\shapes:/shapes -v %cd%\doc/gen/:/doc/gen ghcr.io/skemu/rdf-template:latest
```

de '-v' optie bind de lokale folders aan het docker image.

$(pwd)/config:/config koppelt de /config folder uit deze repository aan de docker container
De output folderlocatie wordt vervolgens weer gebruikt in de index.html file om de gegeneerde documentatie op te nemen in de respec publicatie.

$(pwd)/shapes:/shapes koppelt de /shapes folder uit deze repository aan de docker container

$(pwd)/doc/gen/:/doc/gen koppelt de/doc/gen output folder aan de docker container. Deze output folderlocatie wordt vervolgens weer gebruikt in de index.html file om de gegeneerde documentatie op te nemen in de respec publicatie.
Loading