Skip to content

Commit

Permalink
Minor readme adjustments
Browse files Browse the repository at this point in the history
The readme file for OParl 1.0 was not particalarly helpful
for people from outside the project to begin with. To change
that now would - in a way - break semver rules. Thus the
only change is to hint on the new building strategy without
explaining what all that entails.

However, we should probably consider keeping a more permanent
'How to build this' record somewhere for people who may want
to dig deep into OParls' past someday. Whoever that might be.
  • Loading branch information
eFrane committed Jan 7, 2018
1 parent 78e9406 commit e3b3955
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,8 @@ Die Dateien, aus denen die Spezifikation erstellt wird, sind auf mehrere Ordner
- `examples/`: Die im Text eingebundenen Beispiele
- `scripts/`: Enthält hauptsächlich die python-skripte, die die json-Dateien in Markdown umwandeln

Durch den Befehl `make` kann aus den Quelldateien die Spezifikation erstellt werden. Dazu müssen pandoc und latex installiert sein. Die fertigen Dokumente finden sich dann im Ordner `out`.
Durch den Befehl `python3 build.py` kann aus den Quelldateien die Spezifikation erstellt werden. Dazu müssen pandoc und latex installiert sein.
Die fertigen Dokumente finden sich dann im Ordner `build`.

## Die Spezifikation in verschiedenen Formaten

Expand Down

0 comments on commit e3b3955

Please sign in to comment.