docs: rewrite USAGE in the thematic style and expand README

This commit is contained in:
yyc12345 committed 2026-10-05 11:26:09 +08:00
1 parent 68e4ace92b
commit da2a73d70f
2 files changed
+161 -58

No files matched your search

+7 -2
View File
@@ -1,8 +1,13 @@
# 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.
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>`.
See [USAGE.md](USAGE.md) for workspaces, backups, the search syntax and command-line usage.
- 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