lashman/openpylon
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 3 Wiki Activity

fix README: Windows-only portable exe, remove default icon

Browse Source 
- Platform is Windows only, single portable exe
- Remove icon image reference (using default Tauri icon)
- Use emoji header instead
- Update clone URLs to point to Gitea instance
- Remove installer/macOS/Linux references
This commit is contained in:
Your Name
2026-02-16 15:45:00 +02:00
parent 59aaa688bb
commit fd0fe2cdcc
1 changed files with 24 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files

52
README.md
View File

@@ -1,8 +1,4 @@
<p align="center">
<img src="src-tauri/icons/128x128.png" alt="OpenPylon" width="96" />
</p>
<h1 align="center">OpenPylon</h1>
<h1 align="center">🏗️ OpenPylon</h1>
<p align="center">
<strong>A local-first Kanban board for people who want to own their work.</strong>
@@ -13,7 +9,8 @@
<p align="center">
<img src="https://img.shields.io/badge/license-CC0_1.0-blue" alt="License: CC0 1.0" />
<img src="https://img.shields.io/badge/version-0.1.0-green" alt="Version 0.1.0" />
<img src="https://img.shields.io/badge/platform-Windows%20%7C%20macOS%20%7C%20Linux-lightgrey" alt="Platforms" />
<img src="https://img.shields.io/badge/platform-Windows-0078D4?logo=windows" alt="Windows" />
<img src="https://img.shields.io/badge/portable-no%20install%20needed-brightgreen" alt="Portable" />
<img src="https://img.shields.io/badge/built%20with-Tauri%20v2-orange" alt="Built with Tauri v2" />
</p>
@@ -25,7 +22,7 @@ Your productivity tools shouldn't phone home. They shouldn't harvest your habits
OpenPylon is a desktop Kanban application that keeps everything on your machine. Every board, card, and attachment is a plain JSON file in a folder next to the executable. Copy it to a USB drive. Back it up to a NAS. Share it with your team over a local network. The data is yours — always has been, always will be.
No subscription. No signup. No server between you and your work.
No subscription. No signup. No server between you and your work. No one profits from your productivity except you.
**Built for people, not for platforms.**
@@ -119,32 +116,29 @@ Your work is protected by multiple layers of redundancy — because tools that l
---
## 📥 Installation
## 📥 Getting Started
### Download
Grab the latest release from the [Releases](https://github.com/nicepylon/openpylon/releases) page.
Grab `openpylon.exe` from the [Releases](https://git.lashman.live/lashman/openpylon/releases) page. That's it. Unzip, run, done.
| Platform | Format | Notes |
|---|---|---|
| Windows | `.exe` (portable) | Just unzip and run. No installer needed. |
| Windows | `.msi` / `.exe` (installer) | Traditional install if you prefer it. |
| macOS | `.dmg` | Drag to Applications. |
| Linux | `.AppImage` / `.deb` | AppImage runs anywhere; .deb for Debian/Ubuntu. |
No installer. No admin rights. No registry entries. Runs from anywhere — your desktop, a USB stick, a shared drive. Put it wherever you want. It's yours.
> 💡 **Fully portable** — OpenPylon stores all its data in a `data/` folder right next to the executable. Move the folder, move your data. Delete the folder, it's gone. No traces left behind.
### Build from Source
Anyone can build this. The source is yours.
Anyone can build this. The source is yours to read, modify, and redistribute.
**Prerequisites:**
- [Node.js](https://nodejs.org/) 18+
- [Rust](https://rustup.rs/) (latest stable)
- Platform-specific dependencies per the [Tauri v2 docs](https://v2.tauri.app/start/prerequisites/)
- [Tauri v2 prerequisites](https://v2.tauri.app/start/prerequisites/) for Windows
```bash
# Clone
git clone https://github.com/nicepylon/openpylon.git
git clone https://git.lashman.live/lashman/openpylon.git
cd openpylon
# Install dependencies
@@ -157,7 +151,7 @@ npm run tauri dev
npm run tauri build
```
The compiled binary lands in `src-tauri/target/release/`. Installers (MSI, NSIS, etc.) appear in `src-tauri/target/release/bundle/`.
The portable executable lands in `src-tauri/target/release/openpylon.exe`.
---
@@ -188,7 +182,7 @@ data/
### 📄 Board Format
Each board is a self-contained JSON file with a Zod-validated schema. New fields added in future versions receive sensible defaults on load — so older board files never break. You can read, edit, or script against these files with any tool you like. They're just JSON.
Each board is a self-contained JSON file with a Zod-validated schema. New fields added in future versions receive sensible defaults on load — so older board files never break. You can read, edit, or script against these files with any tool you like. They're just JSON. No proprietary formats, no binary blobs, no vendor lock-in.
### 🔄 Backup and Recovery
@@ -211,7 +205,7 @@ Click the **Import** button on the board list screen and pick a `.json` file. Op
| **OpenPylon JSON** | Everything — full fidelity round-trip, no data loss |
| **Trello JSON** | Lists → columns, cards, labels (with color mapping), checklists. Archived/closed items are skipped. |
Migrating off Trello? Export your board from Trello (Menu → Share → Export as JSON), then import it here. Your data belongs with you.
Migrating off Trello? Export your board from Trello (Menu → Share → Export as JSON), then import it here. Your data belongs with you — not with Atlassian.
### Exporting
@@ -222,13 +216,13 @@ Right-click any board card on the board list to export:
| **JSON** | Full board data. Re-importable into OpenPylon or parseable by any tool. |
| **CSV** | Flat table with board name, column, title, description, labels, due date, checklist progress, and timestamps. Opens in Excel, Sheets, LibreOffice, or anything that reads CSV. |
No lock-in. Take your data wherever you want, whenever you want.
No lock-in. Take your data wherever you want, whenever you want. We'd rather you have the freedom to leave than the obligation to stay.
---
## ⚙️ Settings Reference
### Global Settings
### 🌐 Global Settings
| Setting | Options | Default |
|---|---|---|
@@ -239,14 +233,14 @@ No lock-in. Take your data wherever you want, whenever you want.
| 📏 Default Column Width | Narrow · Standard · Wide | Standard |
| 🗂️ Board Sort Order | Manual · Name · Created · Modified | Modified |
### Per-Board Settings
### 📌 Per-Board Settings
| Setting | Options | Default |
|---|---|---|
| 🖼️ Background | None · Dots · Grid · Gradient | None |
| 📎 Attachment Mode | Link to original · Copy into board | Link |
### Per-Column Settings
### 📊 Per-Column Settings
| Setting | Options |
|---|---|
@@ -273,6 +267,8 @@ No lock-in. Take your data wherever you want, whenever you want.
| 📜 Scrollbars | [OverlayScrollbars](https://kingsora.github.io/OverlayScrollbars/) |
| 🔤 Typography | [Epilogue](https://fonts.google.com/specimen/Epilogue) · [Instrument Serif](https://fonts.google.com/specimen/Instrument+Serif) · [Space Mono](https://fonts.google.com/specimen/Space+Mono) |
All dependencies are free and open-source. No proprietary tooling. No paid services. The entire stack can be audited, forked, and rebuilt by anyone.
---
## 📁 Project Structure
@@ -299,7 +295,7 @@ openpylon/
│ │ ├── lib.rs # Plugin registration, portable data dir command
│ │ └── main.rs # Entry point
│ ├── capabilities/ # Tauri security permissions
│ ├── icons/ # App icons (ICO, ICNS, PNG)
│ ├── icons/ # App icons
│ ├── Cargo.toml # Rust dependencies
│ └── tauri.conf.json # Tauri app configuration
├── docs/plans/ # Design documents and implementation plans
@@ -318,13 +314,13 @@ npm run tauri dev
# Type-check the frontend
npx tsc --noEmit
# Production build (exe + installers)
# Production build (portable exe)
npm run tauri build
```
The dev server runs on `http://localhost:1420` with Vite HMR. Rust backend changes trigger automatic recompilation through Cargo watch.
### Contributing
### 🤝 Contributing
OpenPylon is released into the public domain under CC0 1.0. There's no CLA, no copyright assignment, no gatekeeping. If you want to contribute, just open a PR. If you want to fork it and build something entirely different, go ahead — no permission needed.