JosephFerano/kanban-tui
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fix README backticks

Browse Source
This commit is contained in:
Joseph Ferano 2023-06-17 23:29:09 +07:00
parent d3ea9fc160
commit b8e0a0307e
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.org
View File

@ -16,19 +16,19 @@ I'm an [[https://orgmode.org/][org]] person myself, but if someone actually deci
of minimalism, then I might consider working on it more. of minimalism, then I might consider working on it more.
** Features ** Features
- Terminal-based: Enjoy the simplicity and speed of a text-based interface - Terminal-based: Enjoy the simplicity and speed of a text-based interface
- Vim-like keybindings: For those who have `hjkl` burned into their skull - Vim-like keybindings: For those who have ~hjkl~ burned into their skull
- SQLite backed: Overkill maybe? At least I like SQL - SQLite backed: Overkill maybe? At least I like SQL
- No bloat: Just create a task and move it around - No bloat: Just create a task and move it around
** Building and Installing ** Building and Installing
To build and install kanban-tui, follow these steps: To build and install kanban-tui, follow these steps:
- Install Rust: If you don't have Rust installed, you can get it from [[https://www.rust-lang.org/tools/install][here]]. - Install Rust: If you don't have Rust installed, you can get it from [[https://www.rust-lang.org/tools/install][here]].
- Clone this repository, cd into it - Clone this repository, cd into it
- Build the project: `cargo build --release` - Build the project: ~cargo build --release~
- The built binary can be found in `target/release/kanban-tui` - The built binary can be found in ~target/release/kanban-tui~
- Optionally, you can move the binary to a directory in your PATH for easier - Optionally, you can move the binary to a directory in your PATH for easier
access. access.
** Usage ** Usage
It is recommended to run `kanban-tui` from the root of your project so it can It is recommended to run ~kanban-tui~ from the root of your project so it can
pick up the project's name. This automatically creates a SQLite database there pick up the project's name. This automatically creates a SQLite database there
named ~kanban.db~. named ~kanban.db~.