pelican/README.asciidoc
Dan Anglin 155dab0918
Some checks failed
/ test (pull_request) Successful in 28s
/ lint (pull_request) Failing after 3m41s
chore: project maintenance
Changes:

- Changed README from Markdown to Asciidoc
- Updated go.mod and go.sum
- Updated magefiles for CI
- Added workflow for Forgejo Actions
2023-12-12 10:05:25 +00:00

22 lines
584 B
Text

= Pelican
== Summary
**This project is WIP and is not meant for production use**
Pelican is a simple Kanban board for your terminal.
== Storage
Data is stored in a https://github.com/etcd-io/bbolt[BoltDB] database.
For Linux the default the database file is located at $XDG\_DATA\_HOME/canal/canal.db
If $XDG\_DATA\_HOME is not set then the default location is $HOME/.local/share/canal/canal.db by default.
For all other operating systems the default location is $HOME/.canal/canal.db.
== Keybindings
TBC
## Inspiration
https://github.com/witchard/toukan[The toukan project]