Skip to content

Commit

Permalink
docs: Refactor project documentation and installation steps
Browse files Browse the repository at this point in the history
- Rearranged steps in README.md for better clarity
- Added step to archive processed audio files
- Updated README with new installation step for configuration bootstrapping
  • Loading branch information
johnnyhuy committed Apr 16, 2024
1 parent 85668d9 commit 4d22d0a
Showing 1 changed file with 12 additions and 4 deletions.
16 changes: 12 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,19 +72,27 @@ The Transcribe Me application follows a straightforward workflow:

## :wrench: Usage

1. Place your audio files in the `input` directory (or any other directory specified in the configuration).
2. Run the application:
1. Bootstrap your current directory with the configuration file:

```bash
transcribe-me
transcribe-me install
```

2. Place your audio files in the `input` directory (or any other directory specified in the configuration).
3. Run the application:

```bash
make transcribe
transcribe-me
```

The application will transcribe each audio file in the input directory and save the transcriptions to the output directory. It will also generate summaries of the transcriptions using the configured models and save them to the output directory.

4. (Optional) You can archive the input directory to keep track of the processed audio files:

```bash
transcribe-me archive
```

## :gear: Configuration

The application uses a configuration file (`.transcribe.yaml`) to specify settings such as input/output directories, API keys, models, and their configurations. The configuration file is created automatically when you run the `transcribe-me install` command.
Expand Down

0 comments on commit 4d22d0a

Please sign in to comment.