2023-05-06 12:49:40 +01:00
|
|
|
# Pelican
|
2021-08-12 19:35:20 +01:00
|
|
|
|
2023-05-06 12:49:40 +01:00
|
|
|
## Summary
|
|
|
|
|
|
2023-05-06 12:53:03 +01:00
|
|
|
**This project is WIP and is not meant for production use**
|
|
|
|
|
|
2023-05-06 12:49:40 +01:00
|
|
|
Pelican is a simple Kanban board for your terminal.
|
|
|
|
|
|
|
|
|
|
## Storage
|
|
|
|
|
|
|
|
|
|
Data is stored in a [BoltDB](https://github.com/etcd-io/bbolt) 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
|
|
|
|
|
|
2023-05-06 12:53:03 +01:00
|
|
|
TBC
|
|
|
|
|
|
2023-05-06 12:49:40 +01:00
|
|
|
## Inspiration
|
|
|
|
|
|
|
|
|
|
[The toukan project](https://github.com/witchard/toukan).
|
