split readme
This commit is contained in:
CJ Pais
parent
5c712e00dd
commit
90bef969a9
2 changed files with 61 additions and 56 deletions
54
BUILD.md
Normal file
54
BUILD.md
Normal file
|
|
@ -0,0 +1,54 @@
|
|||
# Build Instructions
|
||||
|
||||
This guide covers how to set up the development environment and build Handy from source across different platforms.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
### All Platforms
|
||||
- [Rust](https://rustup.rs/) (latest stable)
|
||||
- [Bun](https://bun.sh/) package manager
|
||||
- [Tauri Prerequisites](https://tauri.app/start/prerequisites/)
|
||||
|
||||
### Platform-Specific Requirements
|
||||
|
||||
#### macOS
|
||||
- Xcode Command Line Tools
|
||||
- Install with: `xcode-select --install`
|
||||
|
||||
#### Windows
|
||||
- Microsoft C++ Build Tools
|
||||
- Visual Studio 2019/2022 with C++ development tools
|
||||
- Or Visual Studio Build Tools 2019/2022
|
||||
|
||||
#### Linux
|
||||
- Build essentials
|
||||
- ALSA development libraries
|
||||
- Install with:
|
||||
```bash
|
||||
# Ubuntu/Debian
|
||||
sudo apt update
|
||||
sudo apt install build-essential libasound2-dev pkg-config libssl-dev
|
||||
|
||||
# Fedora/RHEL
|
||||
sudo dnf groupinstall "Development Tools"
|
||||
sudo dnf install alsa-lib-devel pkgconf openssl-devel
|
||||
|
||||
# Arch Linux
|
||||
sudo pacman -S base-devel alsa-lib pkgconf openssl
|
||||
```
|
||||
|
||||
## Setup Instructions
|
||||
|
||||
### 1. Clone the Repository
|
||||
```bash
|
||||
git clone git@github.com:cjpais/Handy.git
|
||||
cd Handy
|
||||
```
|
||||
|
||||
### 2. Install Dependencies
|
||||
```bash
|
||||
bun install
|
||||
```
|
||||
|
||||
### 3. Download Required Models
|
||||
Handy requires a VAD (Voice Activity Detection) model to function
|
||||
63
README.md
63
README.md
|
|
@ -41,43 +41,7 @@ The process is entirely local:
|
|||
|
||||
### Development Setup
|
||||
|
||||
**Prerequisites:**
|
||||
- [Rust](https://rustup.rs/) (latest stable)
|
||||
- [Bun](https://bun.sh/) package manager
|
||||
- [Tauri Prerequisites](https://tauri.app/start/prerequisites/)
|
||||
- Platform-specific requirements:
|
||||
- **macOS**: Xcode Command Line Tools
|
||||
- **Windows**: Microsoft C++ Build Tools
|
||||
- **Linux**: Build essentials, ALSA development libraries
|
||||
|
||||
**Getting Started:**
|
||||
|
||||
```bash
|
||||
# Clone the repository
|
||||
git clone git@github.com:cjpais/Handy.git
|
||||
cd Handy
|
||||
|
||||
# Install dependencies
|
||||
bun install
|
||||
|
||||
# Run in development mode
|
||||
bun run tauri dev
|
||||
# if it fails with cmake error on MacOS, try
|
||||
CMAKE_POLICY_VERSION_MINIMUM=3.5 bun run tauri dev
|
||||
|
||||
# Build for production
|
||||
bun run tauri build
|
||||
```
|
||||
|
||||
**Whisper Models:**
|
||||
|
||||
The app now supports dynamic model downloading and switching:
|
||||
- **Small**: Fast, good for most use cases
|
||||
- **Medium**: Better accuracy, balanced performance
|
||||
- **Turbo**: Optimized large model with improved speed
|
||||
- **Large**: Highest accuracy, slower processing
|
||||
|
||||
Users can download and switch between models directly from the app's settings interface. No models are bundled with the app, reducing the initial download size.
|
||||
For detailed build instructions including platform-specific requirements, see [BUILD.md](BUILD.md).
|
||||
|
||||
## Architecture
|
||||
|
||||
|
|
@ -101,27 +65,14 @@ This project is actively being developed and has some [known issues](https://git
|
|||
- **x64 Windows**
|
||||
- **x64 Linux**
|
||||
|
||||
### Active Issues
|
||||
- Paste functionality occasionally produces just 'v' instead of full text on macOS
|
||||
- VAD filter sometimes includes trailing "thank you" in transcriptions
|
||||
- Transcription end-cutting due to potential threading issues
|
||||
- Microphone remains active for optimal latency (design choice under discussion)
|
||||
### System Requirements/Recomendations
|
||||
|
||||
## Contributing
|
||||
The following are recommendations for running Handy on your own machine. If you don't meet the system requirements, the performance of the application may be degraded. We are working on improving the performance across all kinds of computers and hardware.
|
||||
|
||||
We're actively seeking contributors! Priority areas include:
|
||||
|
||||
### High Priority
|
||||
1. **Cross-platform support** - Windows and Linux compatibility
|
||||
2. **Code quality improvements** - Better error handling, architecture refinements
|
||||
3. **Bug fixes** - Address the known issues listed above
|
||||
4. **Performance optimization** - Reduce latency, improve resource usage
|
||||
|
||||
### Feature Requests
|
||||
- Configurable microphone selection
|
||||
- Multiple STT model options (beyond Whisper Small)
|
||||
- Modifier-only key bindings
|
||||
- Enhanced VAD configuration
|
||||
- **macOS**: M series Mac
|
||||
- **Windows**: Intel, AMD, or NVIDIA GPU
|
||||
- **Linux**: Intel, AMD, or NVIDIA GPU
|
||||
* Ubuntu 22.04, 24.04
|
||||
|
||||
### How to Contribute
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue