Improvements to the documentation

This commit is contained in:
Solene Rapenne 2021-07-20 22:55:12 +02:00
parent 221fd26a56
commit 9d5d1f5f68
1 changed files with 32 additions and 2 deletions

View File

@ -4,10 +4,12 @@ potcasse is meant to help people to publish and self host a podcast easily witho
# 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 generate the structure that you will publish on a web server.
## First time
@ -15,6 +17,18 @@ potcasse is meant to help people to publish and self host a podcast easily witho
potcasse init
```
This will create a file `metadata.sh` that you need to edit accordingly to your setup.
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://tilde.example/myname/podcast/`
+ 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/to/audio/file this_i
potcasse gen
```
this will create a `output_html` directory with your audio files, the RSS file and potentially a logo file if any.
this will create or update the `output_html` directory with your audio files, the RSS file and the logo file if any.
# Real world example
My podcast feed is available at `https://perso.pw/lambda/feed.xml` which is on server `perso.pw` in `/var/www/htdocs/lambda/`.
I add new episodes with `potcasse episode "A made something nice" ~/Podcast/episodeXX/file.ogg` then I use `potcasse gen` that will refresh the directory `public_html` with metadata and episodes, finally I put it online with `rsync -av public_html/ perso.pw:/var/www/htdocs/lamda/`.
My `metadata.sh` looks like this:
```
TITLE="Lambda Solene"
AUTHOR=Solene
SITE=https://perso.pw/lambda/
RSSLINK=feed.xml
IMAGE=YES
```