Merge branch 'master' of github.com:tallguyjenks/flash.sh

.github/FUNDING.yml

@@ -0,0 +1,7 @@
+# These are supported funding model platforms
+
+custom: ["https://www.paypal.me/tallguyjenks"]
+
+patreon: ["https://www.patreon.com/bryanjenks?fan_landing=true"]
+
+custom: ["https://www.buymeacoffee.com/tallguyjenks"]

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,48 @@
+---
+name: Bug report
+about: Notify us of issues to help us improve
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Terminal Emulator [e.g. st, kitty, etc]
+ - Shell [e.g. bash, zsh, fish]
+
+**Additional context**
+Add any other context about the problem here.
+
+
+<!--
+Please keep the below portion in your issue. Your issue will be closed if any of the boxes is not checked (i.e., replace `[ ]` by `[x]`).
+-->
+
+---
+
+By filing an issue to this repo, I promise that
+
+- [ ] I have provided the necessary information about my bug report
+- [ ] I have downloaded the latest version of this repo and reproduced my issue with the latest version
+- [ ] If I have posted the same issue elsewhere, I have also mentioned it in this issue.
+- [ ] I have learned the Github Markdown syntax, and formatted my issue correctly.
+
+I understand that my issue may be closed if I don't fulfill my promises.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: enhancement
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

CONTRIBUTING.md

@@ -0,0 +1,9 @@
+We welcome contributions to **Flash.sh**. To submit a contribution:
+
+1.  [Fork](https://github.com/tallguyjenks/flash.sh/fork) the repository and make your changes.
+
+2.  Submit a [pull request](https://help.github.com/articles/using-pull-requests).
+
+I'll try to be as responsive as possible in reviewing and accepting pull requests. 
+
+I appreciate your contributions very much!

README.md

@@ -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
+**First Field:** _The category of the flashcard_
-**Second Field:** The Question being asked
+
-**Third Field:** The Hidden Answer
+**Second Field:** _The Question being asked_
-**Fourth Field:** The Score*
+
+**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>