Files
YKanBan/README.md
T

28 lines
1020 B
Markdown
Raw Normal View History

2026-09-29 20:16:52 +08:00
# YKanBan
A personal, local/offline kanban board. Cross-platform desktop app built with Avalonia UI and MVVM. Each workspace stores its data in a `.ykanban` folder at the project root, Git-style; start it with `ykanban <path>`.
2026-09-29 20:16:52 +08:00
- One board per workspace, with columns, cards and colored tags.
- Strict search expressions, for example `tag:bug OR title:login`.
- Markdown export of the whole board, and a tag manager.
- Multi-language interface; light, dark or system theme.
See [USAGE.md](USAGE.md) for installing, starting YKanBan, workspaces and backups, the search syntax and the settings file.
## Building
Requires the .NET 10 SDK.
```
dotnet build YKanBan.slnx
dotnet test YKanBan.slnx
dotnet run --project YKanBan -- <path>
```
Packages are pinned in `YKanBan/YKanBan.csproj`.
2026-10-04 22:15:23 +08:00
Release archives for win-x64, linux-x64 and osx-arm64 are produced by the manually triggered workflow in `.github/workflows/build.yml`; `packaging/package.sh` packs one published RID.
## License
MIT — see [LICENSE](LICENSE).