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

README Edits

This commit is contained in:
Bryan Jenks 2020-04-19 01:05:56 -07:00 committed by GitHub
parent 83fa8f8dec
commit 872723ddb9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 20 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

@ -1,7 +1,9 @@
<!-- Header & Preview Image -->
<h1 align="center">
<img src="/img/flashheader.png" height="50%" width="50%">
</h1>
<!-- Description -->
> flashcards in your terminal! This script was inspired by a basic script i saw in a youtube video by a user named nixcasts. I Like the Anki flashcard system and so im working to replicate it in a simple manner using plain text documents and a shell script to aid my ability to study with active recall and spaced repetition.
![Preview](./img/flash_preview.png)
@ -10,7 +12,7 @@ This script is an expanded version of the one featured in [This nixcasts Video](
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 as you want, 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. There is also no practical limit on the amount of 'cards' a 'deck' can hold.
## Dependencies
@ -33,19 +35,31 @@ Organized like this:
> `category:question:answer:0`
**First Field:** The category of the flashcard
**Second Field:** The Question being asked
**Third Field:** The Hidden Answer
**Fourth Field:** The Score*
**First Field:** _The category of the flashcard_
**Second Field:** _The Question being asked_
**Third Field:** _The Hidden Answer_
**Fourth Field:** _The Score*_
> \* The score determines how often which cards are shown to you. a good idea is to start all your cards out at 0 so they are all served to you equally. As you study and review and mark the more familiar cards as 'Mild' or 'Easy' more points will be added. The lower point cards are sorted to the top and the top 10 are taken and shuffled and then drawn from. This way as you learn the material the items you are less familiar with bubble up into the shuffled pool for drawing and those that go up in points due to increased familiarity go down because you're rating the material as easier.
## Videos
[Flash Cards In Your Terminal With Flash.sh](https://www.youtube.com/watch?v=KEWhOzDCfLg)
enjoy!
## Support
This is free, open-source software. If you'd like to support the development of future projects, or say thanks for this one, you can donate to me through [paypal](https://www.paypal.me/tallguyjenks) or buy me a coffee:
<!-- Buy me a coffee -->
<a href="https://www.buymeacoffee.com/tallguyjenks" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png" alt="Buy Me A Coffee" style="height: 41px !important;width: 174px !important;box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;-webkit-box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;" ></a>
<!-- Footer Image -->
<h1 align="center">
<img src="/img/flashfooter.png">
</h1>
<!-- Shields -->
<p align="center"><a href="https://github.com/tallguyjenks/flash.sh/blob/master/LICENSE"><img src="https://img.shields.io/static/v1.svg?style=flat-square&label=License&message=MIT&logoColor=eceff4&logo=github&colorA=black&colorB=green"/></a></p>