pali112
/
fla.sh
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

edit readme

This commit is contained in:
Bryan Jenks 2020-04-16 22:16:30 -07:00
parent d02fd7737a
commit 774ff7c6de
2 changed files with 20 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
README.md
View File

@ -1,18 +1,33 @@
<h1 align="center">
# flash.sh
</h1>
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:

BIN
img/flash_preview.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 517 KiB