Update to docs

This commit is contained in:
Connor Yoh 2025-07-04 15:01:11 +01:00
parent 780bd663bb
commit 42e6ab0dcd
4 changed files with 24 additions and 2 deletions

View File

@ -25,12 +25,12 @@ Run the appropriate build script for your platform:
**Linux/macOS:** **Linux/macOS:**
```bash ```bash
./build-tauri-jlink.sh ./scripts/build-tauri-jlink.sh
``` ```
**Windows:** **Windows:**
```cmd ```cmd
build-tauri-jlink.bat scripts\build-tauri-jlink.bat
``` ```
### 2. Build Tauri Application ### 2. Build Tauri Application

View File

@ -32,6 +32,12 @@ This guide focuses on developing for Stirling 2.0, including both the React fron
- Docker for containerization - Docker for containerization
- Gradle for build management - Gradle for build management
**Desktop Application (Tauri):**
- Tauri for cross-platform desktop app packaging
- Rust backend for system integration
- PDF file association support
- Self-contained JRE bundling with JLink
**Legacy (reference only during development):** **Legacy (reference only during development):**
- Thymeleaf templates (being completely replaced in 2.0) - Thymeleaf templates (being completely replaced in 2.0)
@ -44,6 +50,8 @@ This guide focuses on developing for Stirling 2.0, including both the React fron
- Java JDK 17 or later (JDK 21 recommended) - Java JDK 17 or later (JDK 21 recommended)
- Node.js 18+ and npm (required for frontend development) - Node.js 18+ and npm (required for frontend development)
- Gradle 7.0 or later (Included within the repo) - Gradle 7.0 or later (Included within the repo)
- Rust and Cargo (required for Tauri desktop app development)
- Tauri CLI (install with `cargo install tauri-cli`)
### Setup Steps ### Setup Steps
@ -95,6 +103,14 @@ Stirling 2.0 uses client-side file storage:
### Legacy Code Reference ### Legacy Code Reference
The existing Thymeleaf templates remain in the codebase during development as reference material but will be completely removed for the 2.0 release. The existing Thymeleaf templates remain in the codebase during development as reference material but will be completely removed for the 2.0 release.
### Tauri Desktop App Development
Stirling-PDF can be packaged as a cross-platform desktop application using Tauri with PDF file association support and bundled JRE:
**Quick Start:**
1. **Development/Testing**: `cargo tauri dev --no-watch -- -- "path/to/test.pdf"`
2. **Building**: See [DesktopApplicationDevelopmentGuide.md](DesktopApplicationDevelopmentGuide.md) for complete build instructions
3. **Features**: File associations, self-contained JRE, cross-platform support
## 5. Project Structure ## 5. Project Structure
```bash ```bash
@ -109,6 +125,12 @@ Stirling-PDF/
│ │ ├── services/ # API and utility services │ │ ├── services/ # API and utility services
│ │ ├── types/ # TypeScript type definitions │ │ ├── types/ # TypeScript type definitions
│ │ └── utils/ # Utility functions │ │ └── utils/ # Utility functions
│ ├── src-tauri/ # Tauri desktop app configuration
│ │ ├── src/ # Rust backend code
│ │ ├── libs/ # JAR files (generated by build scripts)
│ │ ├── runtime/ # Bundled JRE (generated by build scripts)
│ │ ├── Cargo.toml # Rust dependencies
│ │ └── tauri.conf.json # Tauri configuration
│ ├── public/ │ ├── public/
│ │ └── locales/ # Internationalization files (JSON) │ │ └── locales/ # Internationalization files (JSON)
│ ├── package.json # Frontend dependencies │ ├── package.json # Frontend dependencies