Add build system for native applications
- PyInstaller spec file for cross-platform builds - Build scripts for Linux/macOS (build.sh) and Windows (build.bat) - requirements.txt with all dependencies - Updated README with build and installation instructions - Support for creating standalone executables for all platforms 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
This commit is contained in:
64
README.md
64
README.md
@@ -26,6 +26,17 @@ A Python GUI application for generating and playing interactive word search puzz
|
||||
|
||||
## Installation
|
||||
|
||||
### Option 1: Download Pre-built Application (Recommended)
|
||||
|
||||
Download the pre-built application for your platform from the releases page:
|
||||
- **Windows**: `WordSearch.exe`
|
||||
- **macOS**: `WordSearch.app`
|
||||
- **Linux**: `WordSearch` (executable)
|
||||
|
||||
No installation required - just download and run!
|
||||
|
||||
### Option 2: Run from Source
|
||||
|
||||
1. Clone the repository:
|
||||
```bash
|
||||
git clone https://git.firebugit.com/ksmith/WordSearch.git
|
||||
@@ -34,12 +45,19 @@ cd WordSearch
|
||||
|
||||
2. Install required dependencies:
|
||||
```bash
|
||||
pip install reportlab
|
||||
pip install -r requirements.txt
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
Run the application:
|
||||
### Running the Application
|
||||
|
||||
**From pre-built executable:**
|
||||
- **Windows**: Double-click `WordSearch.exe`
|
||||
- **macOS**: Double-click `WordSearch.app` or run `open WordSearch.app`
|
||||
- **Linux**: Run `./WordSearch` from terminal
|
||||
|
||||
**From source:**
|
||||
```bash
|
||||
python word_search_generator.py
|
||||
```
|
||||
@@ -86,6 +104,48 @@ python word_search_generator.py
|
||||
- ReportLab for PDF generation
|
||||
- Event-driven architecture for mouse interactions
|
||||
|
||||
## Building from Source
|
||||
|
||||
To create standalone executables for distribution:
|
||||
|
||||
### Prerequisites
|
||||
|
||||
Install build dependencies:
|
||||
```bash
|
||||
pip install -r requirements.txt
|
||||
```
|
||||
|
||||
### Building
|
||||
|
||||
**Linux/macOS:**
|
||||
```bash
|
||||
./build.sh
|
||||
```
|
||||
|
||||
**Windows:**
|
||||
```cmd
|
||||
build.bat
|
||||
```
|
||||
|
||||
The built application will be in the `dist/` directory:
|
||||
- **Linux**: `dist/WordSearch`
|
||||
- **macOS**: `dist/WordSearch.app`
|
||||
- **Windows**: `dist/WordSearch.exe`
|
||||
|
||||
### Manual Build
|
||||
|
||||
You can also build manually using PyInstaller:
|
||||
```bash
|
||||
pyinstaller word_search.spec
|
||||
```
|
||||
|
||||
### Cross-Platform Notes
|
||||
|
||||
- PyInstaller creates platform-specific executables
|
||||
- Build on the target platform (Windows build requires Windows, etc.)
|
||||
- macOS builds create an `.app` bundle
|
||||
- Linux/Windows builds create a single executable file
|
||||
|
||||
## License
|
||||
|
||||
Created by Keith Smith
|
||||
|
||||
Reference in New Issue
Block a user