docs: reorganize documentation and add detailed building guide
This commit is contained in:
parent
f96f22a1b2
commit
d21f176bdc
56
BUILDING.md
Normal file
56
BUILDING.md
Normal file
@ -0,0 +1,56 @@
|
||||
# Building VoiceInk
|
||||
|
||||
This guide provides detailed instructions for building VoiceInk from source.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
Before you begin, ensure you have:
|
||||
- macOS 14.0 or later
|
||||
- Xcode (latest version recommended)
|
||||
- Swift (latest version recommended)
|
||||
- whisper.cpp properly set up
|
||||
|
||||
## Building Steps
|
||||
|
||||
1. Clone the repository
|
||||
```bash
|
||||
git clone https://github.com/Beingpax/VoiceInk.git
|
||||
cd VoiceInk
|
||||
```
|
||||
|
||||
2. Open the project in Xcode
|
||||
```bash
|
||||
open VoiceInk.xcodeproj
|
||||
```
|
||||
|
||||
3. Build and Run
|
||||
- Build the project using Cmd+B or Product > Build
|
||||
- Run the project using Cmd+R or Product > Run
|
||||
|
||||
## Development Setup
|
||||
|
||||
1. **Xcode Configuration**
|
||||
- Ensure you have the latest Xcode version
|
||||
- Install any required Xcode Command Line Tools
|
||||
|
||||
2. **Dependencies**
|
||||
- The project uses whisper.cpp for transcription
|
||||
- Make sure whisper.cpp is properly set up in your environment
|
||||
|
||||
3. **Building for Development**
|
||||
- Use the Debug configuration for development
|
||||
- Enable relevant debugging options in Xcode
|
||||
|
||||
4. **Testing**
|
||||
- Run the test suite before making changes
|
||||
- Ensure all tests pass after your modifications
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
If you encounter any build issues:
|
||||
1. Clean the build folder (Cmd+Shift+K)
|
||||
2. Clean the build cache (Cmd+Shift+K twice)
|
||||
3. Check Xcode and macOS versions
|
||||
4. Verify all dependencies are properly installed
|
||||
|
||||
For more help, please check the [issues](https://github.com/Beingpax/VoiceInk/issues) section or create a new issue.
|
||||
34
README.md
34
README.md
@ -14,35 +14,23 @@ VoiceInk is a powerful macOS application that transforms your voice into text in
|
||||
## Requirements
|
||||
|
||||
- macOS 14.0 or later
|
||||
- Xcode (latest version recommended)
|
||||
- Swift (latest version recommended)
|
||||
- whisper.cpp
|
||||
|
||||
## Installation
|
||||
## Documentation
|
||||
|
||||
1. Clone the repository
|
||||
```bash
|
||||
git clone https://github.com/yourusername/VoiceInk.git
|
||||
cd VoiceInk
|
||||
```
|
||||
|
||||
2. Open the project in Xcode
|
||||
```bash
|
||||
open VoiceInk.xcodeproj
|
||||
```
|
||||
|
||||
3. Build and run the project
|
||||
|
||||
## Building from Source
|
||||
|
||||
1. Ensure you have all the requirements installed
|
||||
2. Open the project in Xcode
|
||||
3. Build the project using Cmd+B or Product > Build
|
||||
4. Run the project using Cmd+R or Product > Run
|
||||
- [Building from Source](BUILDING.md) - Detailed instructions for building the project
|
||||
- [Contributing Guidelines](CONTRIBUTING.md) - How to contribute to VoiceInk
|
||||
- [Code of Conduct](CODE_OF_CONDUCT.md) - Our community standards
|
||||
|
||||
## Contributing
|
||||
|
||||
We welcome contributions! Please read our [CONTRIBUTING.md](CONTRIBUTING.md) guide before submitting any changes.
|
||||
We welcome contributions! However, please note that all contributions should align with the project's goals and vision. Before starting work on any feature or fix:
|
||||
|
||||
1. Read our [Contributing Guidelines](CONTRIBUTING.md)
|
||||
2. Open an issue to discuss your proposed changes
|
||||
3. Wait for maintainer feedback
|
||||
|
||||
For build instructions, see our [Building Guide](BUILDING.md).
|
||||
|
||||
## License
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user