Skip to content

Commit 8e60e44

Browse files
KevenWMarkhamclaude
andcommitted
docs: add comprehensive installation guide for fresh machine setup
Add detailed step-by-step installation guide covering: - Prerequisites installation (Node.js, Git, Python, code editor) - Repository cloning from GitHub - Project setup and dependency installation - Environment configuration with Gemini API key - Building for development and production - Running the application (4 different modes) - Installation verification steps - Troubleshooting common issues (8 scenarios) - Quick reference command cheat sheet Update existing documentation to reference new guide: - dev.md: Add prominent note for new developers - README.md: Add "For Developers" section with guide links - docs/manual.html: Add styled developer section with links 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent 6b999e7 commit 8e60e44

File tree

4 files changed

+901
-4
lines changed

4 files changed

+901
-4
lines changed

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,8 @@
3838

3939
### Installation
4040

41+
#### For End Users
42+
4143
#### Windows
4244

4345
1. Download `Transcript Parser-Setup-1.0.0.exe` from the releases
@@ -49,6 +51,13 @@
4951
- Download `Transcript Parser-Portable-1.0.0.exe`
5052
- Run directly without installation (no admin rights required)
5153

54+
#### For Developers
55+
56+
If you want to build the application from source:
57+
58+
1. See [Installation Guide](docs/installation-guide.md) for complete setup instructions
59+
2. See [dev.md](dev.md) for development workflow and project structure
60+
5261
### First Launch
5362

5463
1. **Set up API Access**

dev.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,23 @@
11
# Transcript Parser - Development Setup
22

3+
> **New to this project?** If you're setting up a fresh machine from scratch, see the comprehensive [Installation Guide](docs/installation-guide.md) for step-by-step instructions on installing all prerequisites (Node.js, Git, Python, etc.) and getting the project running.
4+
35
## Prerequisites
46

5-
- **Node.js** (v18 or higher)
7+
This guide assumes you already have the following installed:
8+
9+
- **Node.js** (v18 or higher) - [Download](https://nodejs.org/)
610
- **npm** (comes with Node.js)
7-
- **Git** (for version control and Husky git hooks)
11+
- **Git** (for version control and Husky git hooks) - [Download](https://git-scm.com/)
812
- **Google Gemini API Key** (for transcription functionality)
913
- Get your API key from [Google AI Studio](https://makersuite.google.com/app/apikey)
1014
- Create a `.env` file in the project root:
1115
```bash
1216
VITE_GEMINI_API_KEY=your_api_key_here
1317
```
1418

19+
If you need help installing these prerequisites, see [docs/installation-guide.md](docs/installation-guide.md).
20+
1521
## Complete Dependencies List
1622

1723
### Production Dependencies

0 commit comments

Comments
 (0)