tropes-desktop/README.md
2025-08-10 02:19:27 -04:00

47 lines
1.5 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# 🛋️ Tropes
Tropes is a simple desktop frontend for TV Tropes.
## 🗓️ Update Cycle
| Type | Frequency |
| ------------ | -------------------- |
| Minor Update | Every 36 months |
| Patch Update | Monthly or as needed |
| Major Update | As needed |
## 🖥️ Platform Support
| Target | Windows | macOS | Linux |
| ------- | ------- | ------ | ----- |
| x86_64 | ✅ | ⚠️[^1] | ✅ |
| aarch64 | ✅ | ✅ | ✅ |
[^1]: [Rust 1.89](https://blog.rust-lang.org/2025/08/07/Rust-1.89.0/) downgrades AMD64 support after Apple and GitHub CI did the same.
## 🛡️ Support
- [x] Active Support
- [ ] Limited Support (Security patches only)
- [ ] Maintenance Mode (Dependency-only updates)
- [ ] Archived (No active work planned)
## 🧰 Recommended IDE Setup
Before you begin, ensure you have the latest versions of the following installed:
- [VS Code](https://code.visualstudio.com/) (or [VSCodium](https://vscodium.com/))
- [Tauri](https://marketplace.visualstudio.com/items?itemName=tauri-apps.tauri-vscode)
- [Rust](https://www.rust-lang.org/tools/install)
- [rust-analyzer](https://marketplace.visualstudio.com/items?itemName=rust-lang.rust-analyzer)
- [Bun](https://bun.com/)
## 🛠️ Getting Started
1. Install dependencies with `bun install`
2. Simply type `bun tauri dev` to run the application
3. Finally, you can compile your own copy with `bun tauri build`.
## License
I license this project under the GPL-3.0 license - see [LICENSE](LICENSE) for details.