first README.md version

This commit is contained in:
Solene Rapenne 2021-07-20 22:18:14 +02:00
parent 7d50f07ca0
commit 221fd26a56
1 changed files with 38 additions and 0 deletions

38
README.md Normal file
View File

@ -0,0 +1,38 @@
# Introduction
potcasse is meant to help people to publish and self host a podcast easily without using a third service.
# Dependencies
* rsync
# How to use
## First time
```
potcasse init
```
## New episode
```
potcasse episode "Episode XX: trying something weird" /path/to/audio/file
```
This will create a directory episodes/YYYYMMDDhh so you can't publish more than a podcast every hour using this command. The audio file inherits the directory name.
You can force a directory name with a parameter after the audio file.
```
potcasse episode "Episode XX: trying something weird" /path/to/audio/file this_is_my_podcast_episode_i_want_to_name
```
## Publishing
```
potcasse gen
```
this will create a `output_html` directory with your audio files, the RSS file and potentially a logo file if any.