mirror of git://bitreich.org/potcasse
doc: bullet lists items must end with a dot.
This commit is contained in:
parent
eb66cea908
commit
f5a3671282
17
README.md
17
README.md
|
@ -4,8 +4,9 @@ potcasse, pronounced "pot kas" is meant to help people to publish and self host
|
||||||
|
|
||||||
# Dependencies
|
# Dependencies
|
||||||
|
|
||||||
* rsync (could use cp but avoid recopying audio files locally)
|
* rsync (could use cp but avoid recopying audio files locally).
|
||||||
* a posix compatible OS (Linux, *BSD, Solaris)
|
* a posix compatible OS (Linux, *BSD, Solaris).
|
||||||
|
* some webserver to host the files.
|
||||||
|
|
||||||
# How to use
|
# How to use
|
||||||
|
|
||||||
|
@ -23,12 +24,12 @@ This will create a file `metadata.sh` that you need to edit accordingly to your
|
||||||
|
|
||||||
It has the following variables:
|
It has the following variables:
|
||||||
|
|
||||||
+ `TITLE`: this is the podcast title
|
+ `TITLE`: this is the podcast title.
|
||||||
+ `AUTHOR`: this is the podcast author (doesn't support multiples authors yet)
|
+ `AUTHOR`: this is the podcast author (doesn't support multiples authors yet).
|
||||||
+ `SITE`: base HTTP URL where your podcast will be available (for example `https://tilde.example/myname/podcast/`
|
+ `SITE`: base HTTP URL where your podcast will be available (for example `https://tilde.example/myname/podcast/`.
|
||||||
+ `RSSLINK`: name of the RSS feed
|
+ `RSSLINK`: name of the RSS feed.
|
||||||
+ `IMAGE`: if value is not empty, potcasse will use the file `logo.png`
|
+ `IMAGE`: if value is not empty, potcasse will use the file `logo.png`.
|
||||||
+ `LANGUAGE`: language code (such as `fr` or `en-us`) that can be potentially used by some players
|
+ `LANGUAGE`: language code (such as `fr` or `en-us`) that can be potentially used by some players.
|
||||||
|
|
||||||
You will share the link `$SITE/index.html` or `$SITE/$RSSLINK` to your listeners.
|
You will share the link `$SITE/index.html` or `$SITE/$RSSLINK` to your listeners.
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue