Skip to content

Commit

Permalink
docs: Improve setup instructions in README
Browse files Browse the repository at this point in the history
- Improve project documentation with a detailed setup flowchart in the README
- Address setup confusion by providing visual aid for installation steps in the README
  • Loading branch information
johnnyhuy committed Apr 4, 2024
1 parent 8a7675c commit 74d5ca3
Showing 1 changed file with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,20 @@

Transcribe Me is a CLI-driven Python application that transcribes audio files using the OpenAI Whisper API and generates summaries of the transcriptions using both OpenAI's GPT-4 and Anthropic's Claude models.

```mermaid
graph TD
A[Load Config] --> B[Get Audio Files]
B --> C{Audio File Exists?}
C --Yes--> D[Transcribe Audio File]
D --> E[Generate Summaries]
E --> F[Save Transcription]
F --> G[Save Summaries]
G --> H[Clean Up Temporary Files]
H --> B
C --No--> I[Print Warning]
I --> B
```

## Setup

1. Clone the repository.
Expand Down Expand Up @@ -37,6 +51,21 @@ Transcribe Me is a CLI-driven Python application that transcribes audio files us
make install-cli
```

```mermaid
graph TD
A[Clone Repository] --> B[Install ASDF and Homebrew]
B --> C[Install Python and FFmpeg]
C --> D[Install Python Dependencies]
D --> E[Configure API Keys]
E --> F[Place Audio Files]
F --> G[Run Application]
A --> D
D --> E
E --> F
F --> G
```

## Usage

1. Place your audio files in the `input` directory (or any other directory specified in the configuration).
Expand Down

0 comments on commit 74d5ca3

Please sign in to comment.