Fix: Outdated readme

master
Jan Girlich 2 years ago
parent 91a518f1aa
commit db48220b57
No known key found for this signature in database
GPG Key ID: D3730FB324783220
  1. 22
      README.markdown

@ -1,6 +1,6 @@
# ds-rss
generate parts of the datenschleuder website from source `data.xml`:
Generate parts of the datenschleuder website from source `data.xml`:
* rss feed as `ds-feed.xml`,
* oldfashioned hypertext `download.html` and
@ -8,18 +8,24 @@ generate parts of the datenschleuder website from source `data.xml`:
utilizing XML transformations.
and supporting to manage the `data.xml`.
And supporting to manage the `data.xml`.
## using
simply call `./gen.sh` for generating the target files.
Simply call `./gen.sh build` for generating the target files.
creating a new entry for `data.xml` is supported with `./gen.sh release` or `./gen.sh release 99` for a custom issue number, here 99.
to omit the explaining information, simply disregard stderr: `./gen.sh release 2>/dev/null`.
replicating entry for ds #99 including the datetime: `./gen.sh release 99 1568505600`.
the release message is whatever are remaining non-numeric arguments: `./gen.sh release 99 1568505600 Die Ausgabe \#100 ist schon einige Zeit fertig und ausgeliefert. Die Freunde der Digitalen Ausgabe wird freuen, dass die Aushabe \#99 nun online ist.`
* Creating a new entry for `data.xml` is supported with `./gen.sh release` or `./gen.sh release 99` for a custom issue
number, here 99.
for sorting `data.xml`, call `./gen.sh sort`.
* To omit the explaining information, simply disregard stderr: `./gen.sh release 2>/dev/null`.
* Replicating entry for ds #99 including the datetime: `./gen.sh release 99 1568505600`.
* the release message is whatever are the remaining non-numeric arguments: `./gen.sh release 99 1568505600 Die Ausgabe
\#100 ist schon einige Zeit fertig und ausgeliefert. Die Freunde der Digitalen Ausgabe wird freuen, dass die Aushabe
\#99 nun online ist.`
* For sorting `data.xml`, call `./gen.sh sort`. (Not implemented yet)
## dependecies

Loading…
Cancel
Save