 |
Improvements to the documentation - potcasse - Podcast publication made easy |
 |
git clone git://bitreich.org/potcasse git://hg6vgqziawt5s4dj.onion/potcasse |
 |
Log |
|
Files |
|
Refs |
|
Tags |
|
README |
|
LICENSE |
|
--- |
|
commit 9d5d1f5f68edcdf72758276baea7306d1411a2ec |
|
parent 221fd26a5690531a02f9edd4a53d719bbd25a36b |
|
Author: Solene Rapenne <[email protected]> |
|
Date: Tue, 20 Jul 2021 22:55:12 +0200 |
|
|
|
Improvements to the documentation |
|
|
|
Diffstat: |
|
M README.md | 34 +++++++++++++++++++++++++++++… |
|
|
|
1 file changed, 32 insertions(+), 2 deletions(-) |
|
--- |
|
diff --git a/README.md b/README.md |
|
@@ -4,10 +4,12 @@ potcasse is meant to help people to publish and self host a p… |
|
|
|
# Dependencies |
|
|
|
-* rsync |
|
+* rsync (could use cp but avoid recopying audio files locally) |
|
+* a posix compatible OS (Linux, *BSD, Solaris) |
|
|
|
# How to use |
|
|
|
+The idea is to regroup audio files with their metadata in a directory and gene… |
|
|
|
## First time |
|
|
|
@@ -15,6 +17,18 @@ potcasse is meant to help people to publish and self host a … |
|
potcasse init |
|
``` |
|
|
|
+This will create a file `metadata.sh` that you need to edit accordingly to you… |
|
+ |
|
+It has the following variables: |
|
+ |
|
++ TITLE: this is the podcast title |
|
++ 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… |
|
++ RSSLINK: name of the RSS feed |
|
++ IMAGE: if value is not empty, potcasse will use the file `logo.png` |
|
+ |
|
+You will share the link `$SITE/$RSSLINK` to your listeners. |
|
+ |
|
## New episode |
|
|
|
``` |
|
@@ -35,4 +49,20 @@ potcasse episode "Episode XX: trying something weird" /path/… |
|
potcasse gen |
|
``` |
|
|
|
-this will create a `output_html` directory with your audio files, the RSS file… |
|
+this will create or update the `output_html` directory with your audio files, … |
|
+ |
|
+# Real world example |
|
+ |
|
+My podcast feed is available at `https://perso.pw/lambda/feed.xml` which is on… |
|
+ |
|
+I add new episodes with `potcasse episode "A made something nice" ~/Podcast/ep… |
|
+ |
|
+My `metadata.sh` looks like this: |
|
+ |
|
+``` |
|
+TITLE="Lambda Solene" |
|
+AUTHOR=Solene |
|
+SITE=https://perso.pw/lambda/ |
|
+RSSLINK=feed.xml |
|
+IMAGE=YES |
|
+``` |
