diff --git a/README.md b/README.md index beb3f1d..19ce17c 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,33 @@ +

# flash.sh +

-flashcards in your terminal! +> flashcards in your terminal! + +![Preview](./img/flash_preview.png) This script is an expanded version of the one featured in [This nixcasts Video](https://www.youtube.com/watch?v=lX8jqo70r1I) -My expanded version will create a `flash` directory in `.local/share/` and create an empty `deck.csv` file for you. +This expanded version will create a `flash` directory in `.local/share/` and create an example `deck.csv` file for you. -You can have as many decks in the `flash` directory and having directories and nested directories filled with `.csv` decks will all work with this system. +You can have as many decks in the `flash` directory as you want, and having directories and nested directories filled with `.csv` decks will all work with this system. -Dependencies for this script are [fzf](https://github.com/junegunn/fzf) and [bat](https://github.com/sharkdp/bat). +## Dependencies + +This script uses: + +- [fzf](https://github.com/junegunn/fzf) +- [bat](https://github.com/sharkdp/bat) + +Install these prior to running the script. + +## Installation To utilize this script copy/move it to your `~/.local/bin/` folder or any place in your `$PATH` -the `deck.csv` file should have colon `:` seperated values in 3 columns +## Usage + +The `deck.csv` file should have colon `:` seperated values in 3 columns Organized like this: diff --git a/img/flash_preview.png b/img/flash_preview.png new file mode 100644 index 0000000..4b108d3 Binary files /dev/null and b/img/flash_preview.png differ