Minor README improvements

This commit is contained in:
Joseph Ferano 2023-06-17 23:31:04 +07:00
parent b8e0a0307e
commit 62e33a8a05

View File

@ -25,7 +25,7 @@ To build and install kanban-tui, follow these steps:
- 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
@ -58,8 +58,8 @@ operations are performed through simple keybindings.
- Reports - Reports
- Export to other formats - Export to other formats
** Acknolwedgements ** Acknolwedgements
[[https://github.com/Karrq][Karrq]] helped suggest a lot of things design wise and even contributed a handie [[https://github.com/Karrq][Karrq]] was nice enough to provide some help from time to time and even
little macro. contributed a handy little macro.
** Contributions ** Contributions
While the project is primarily developed to practice Rust, if for some reason While the project is primarily developed to practice Rust, if for some reason
you like this and want to contribute, open an issue and we can discuss whatever. you like this and want to contribute, open an issue and we can discuss whatever.