Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
souzatharsis committed Oct 27, 2024
1 parent d7002f2 commit 1bfb4b2
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 17 deletions.
16 changes: 0 additions & 16 deletions usage/config_custom.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,6 @@

Podcastfy uses a `config.yaml` file to manage various settings and parameters. This guide explains each configuration option available in the file.

## Customizing the Conversation

See [conversation_custom.md](conversation_custom.md) for more details.

## Output Directories

- `transcripts`: "./data/transcripts"
- Directory where generated transcripts are saved.
- `audio`: "./data/audio"
- Directory where generated audio files are saved.


## Content Generator
Expand Down Expand Up @@ -51,12 +41,6 @@ See [conversation_custom.md](conversation_custom.md) for more details.
- `format`: "%(asctime)s - %(name)s - %(levelname)s - %(message)s"
- Format string for log messages.

## Main Settings

- `default_tts_model`: "openai"
- Default Text-to-Speech model to use when not specified.



## Website Extractor

Expand Down
9 changes: 8 additions & 1 deletion usage/conversation_custom.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,11 +68,18 @@ Podcastfy uses the default TTS configuration stored in [podcastfy/conversation_c

### General TTS Settings

- `default_tts_model`: "edge"
- Default text-to-speech model to use.
- `output_directories`:
- `transcripts`: "./data/transcripts"
- Directory for storing generated transcripts.
- `audio`: "./data/audio"
- Directory for storing generated audio files.
- `audio_format`: "mp3"
- Format of the generated audio files.
- `temp_audio_dir`: "data/audio/tmp/"
- Temporary directory for audio processing.
- `ending_message`: "Tchau!"
- `ending_message`: "Bye Bye!"
- Message to be appended at the end of the podcast.

## Customization Examples
Expand Down

0 comments on commit 1bfb4b2

Please sign in to comment.