Initial project setup with README and gitignore

Establish the voice-to-notes project with documentation covering
goals, platform targets, and planned feature set.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
2026-02-26 08:11:57 -08:00
commit d2bdbe3315
2 changed files with 69 additions and 0 deletions

39
.gitignore vendored Normal file
View File

@@ -0,0 +1,39 @@
# Dependencies
node_modules/
venv/
.venv/
__pycache__/
*.pyc
# Build output
dist/
build/
out/
*.egg-info/
# IDE
.vscode/
.idea/
*.swp
*.swo
# OS
.DS_Store
Thumbs.db
# Environment
.env
.env.local
# Logs
*.log
# Audio/video test files
*.wav
*.mp3
*.mp4
*.mkv
*.avi
*.ogg
*.flac
!test/fixtures/*

30
README.md Normal file
View File

@@ -0,0 +1,30 @@
# Voice to Notes
A desktop application that transcribes audio/video recordings with speaker identification, producing editable transcriptions with synchronized audio playback.
## Goals
- **Speech-to-Text Transcription** — Accurately convert spoken audio from recordings into text
- **Speaker Identification (Diarization)** — Detect and distinguish between different speakers in a conversation
- **Speaker Naming** — Assign and persist speaker names/IDs across the transcription
- **Synchronized Playback** — Click any transcribed text segment to play back the corresponding audio for review and correction
- **Export Formats**
- Closed captioning files (SRT, VTT) for video
- Plain text documents with speaker labels
- **AI Integration** — Connect to AI providers to ask questions about the conversation and generate condensed notes/summaries
## Platform Support
| Platform | Status |
|----------|--------|
| Linux | Planned (initial target) |
| Windows | Planned (initial target) |
| macOS | Future (pending hardware) |
## Project Status
**Early planning phase** — Architecture and technology decisions in progress.
## License
TBD