Compare commits
21 Commits
| Author | SHA1 | Date |
|---|---|---|
|
|
846349613f | |
|
|
942a39114f | |
|
|
37f609eaeb | |
|
|
47a635a645 | |
|
|
8915b54e22 | |
|
|
f5ebff2e15 | |
|
|
960f0b4316 | |
|
|
a16bd4393c | |
|
|
d98f6a4a0b | |
|
|
3876b727d5 | |
|
|
7b5b838965 | |
|
|
58763294be | |
|
|
8876db2694 | |
|
|
bf17b7d3c0 | |
|
|
3ea4c26568 | |
|
|
5ebdfbe263 | |
|
|
eeb7ed900a | |
|
|
c6e14ac11e | |
|
|
032ed7b627 | |
|
|
1f9a0ea7c8 | |
|
|
55b8b9a896 |
|
|
@ -1,5 +1,5 @@
|
|||
# These are supported funding model platforms
|
||||
|
||||
patreon: bryanjenks
|
||||
|
||||
github: tallguyjenks
|
||||
custom: ["https://www.buymeacoffee.com/tallguyjenks", "https://www.paypal.me/tallguyjenks"]
|
||||
|
|
|
|||
|
|
@ -28,6 +28,13 @@ If applicable, add screenshots to help explain your problem.
|
|||
- Terminal Emulator [e.g. st, kitty, etc]
|
||||
- Shell [e.g. bash, zsh, fish]
|
||||
|
||||
## Smartphone (please complete the following information):
|
||||
|
||||
- Device: [e.g. iPhone6]
|
||||
- OS: [e.g. iOS8.1]
|
||||
- Browser [e.g. stock browser, safari]
|
||||
- Version [e.g. 22]
|
||||
|
||||
**Additional context**
|
||||
Add any other context about the problem here.
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1,13 @@
|
|||
name: Greetings
|
||||
|
||||
on: [pull_request, issues]
|
||||
|
||||
jobs:
|
||||
greeting:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/first-interaction@v1
|
||||
with:
|
||||
repo-token: ${{ secrets.GITHUB_TOKEN }}
|
||||
issue-message: 'This was your first issue! Thank you for contributing!'' first issue'
|
||||
pr-message: 'This was your first Pull Request! Thank you for contributing!'' first pr'
|
||||
|
|
@ -0,0 +1,17 @@
|
|||
# from here: https://github.com/marketplace/actions/shellcheck
|
||||
on:
|
||||
push:
|
||||
branch:
|
||||
- master
|
||||
|
||||
name: 'Trigger: Push action'
|
||||
|
||||
jobs:
|
||||
shellcheck:
|
||||
name: Shellcheck
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
- name: ShellCheck
|
||||
uses: ludeeus/action-shellcheck@1.0.0
|
||||
|
||||
|
|
@ -0,0 +1,19 @@
|
|||
name: Mark stale issues and pull requests
|
||||
|
||||
on:
|
||||
schedule:
|
||||
- cron: "30 1 * * *"
|
||||
|
||||
jobs:
|
||||
stale:
|
||||
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
steps:
|
||||
- uses: actions/stale@v1
|
||||
with:
|
||||
repo-token: ${{ secrets.GITHUB_TOKEN }}
|
||||
stale-issue-message: 'Stale issue message'
|
||||
stale-pr-message: 'Stale pull request message'
|
||||
stale-issue-label: 'no-issue-activity'
|
||||
stale-pr-label: 'no-pr-activity'
|
||||
|
|
@ -1,3 +0,0 @@
|
|||
script:
|
||||
# Fail if any of these files have warnings
|
||||
- shellcheck -s bash flash
|
||||
16
README.md
16
README.md
|
|
@ -1,19 +1,15 @@
|
|||
<!-- Header & Preview Image -->
|
||||
<h1 align="center">
|
||||
<img src="/img/flashheader.png" height="50%" width="50%">
|
||||
</h1>
|
||||
|
||||
<!-- Shields -->
|
||||
<p align="center">
|
||||
<a href="https://github.com/tallguyjenks/fla.sh/blob/master/LICENSE"><img src="https://img.shields.io/static/v1.svg?style=flat&label=License&message=MIT&logoColor=eceff4&logo=github&colorA=black&colorB=green"/></a>
|
||||
<a href="https://img.shields.io/travis/tallguyjenks/fla.sh/master"><img src="https://img.shields.io/travis/tallguyjenks/fla.sh/master"></a>
|
||||
<img src="https://img.shields.io/github/commit-activity/m/tallguyjenks/fla.sh">
|
||||
<a href="https://github.com/tallguyjenks/fla.sh/graphs/contributors"><img src="https://img.shields.io/github/contributors/tallguyjenks/fla.sh"></a>
|
||||
<img src="https://img.shields.io/github/v/release/tallguyjenks/fla.sh">
|
||||
</p>
|
||||
|
||||
<!-- 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.
|
||||
> Flashcards in your terminal!
|
||||
>
|
||||
> This script was inspired by a basic script that I had seen in a youtube video by a user named nixcasts. I like the Anki flashcard system, hence I'm 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.
|
||||
|
||||

|
||||
|
||||
|
|
@ -43,7 +39,7 @@ Untested, not sure if this script and its dependencies will work with WSL or not
|
|||
|
||||
Will need to have `brew` to install dependencies listed below and also `brew install coreutils` to get the GNU core utilities as `shuf` is not in macOS by default.
|
||||
|
||||
You will need to put the script itself somewhere in your `$PATH` and execute it to initialize setup.
|
||||
You will need to put the script itself somewhere in your `$PATH` and execute it to initialize the setup.
|
||||
|
||||
Confirmed to work on macOS 10.14.6 more recent version welcome to test and file an issue/pull request to update README if other versions run the script as it should.
|
||||
|
||||
|
|
@ -77,11 +73,11 @@ Organized like this:
|
|||
|
||||
**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.
|
||||
> \* The score determines how often and which cards are shown to you. A good idea is to start all your cards out at 0 so that all are served to you equally. As you study, 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, shuffled, and then drawn from. This way as you learn the material and 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.
|
||||
|
||||
### Decks
|
||||
|
||||
If you would like to browse a collection of decks readily available in your subject matter that are comaptible with [fla.sh](https://github.com/tallguyjenks/fla.sh) then you should check out [Flash Decks](https://github.com/tallguyjenks/Flash-Decks).
|
||||
If you would like to browse through a collection of decks readily available in your subject matter that are comaptible with [fla.sh](https://github.com/tallguyjenks/fla.sh) then you should check out [Flash Decks](https://github.com/tallguyjenks/Flash-Decks).
|
||||
|
||||
## Media (accepting contributions)
|
||||
|
||||
|
|
|
|||
66
flash
66
flash
|
|
@ -114,11 +114,12 @@ Science:What is the distance between the Earth and Sol called?:An Astronomical U
|
|||
Programming:What is the best operating system?:Arch, because BTW i run Arch:999"
|
||||
|
||||
# Define setup process in a function and create necessary files for user
|
||||
setup(){\
|
||||
mkdir "$DIR" && \
|
||||
touch {"$EXAMPLE_DECK","$HIGH_SCORE","$REVIEW_LOG"} && \
|
||||
echo "$DECK_TEMPLATE" >> "$EXAMPLE_DECK" && \
|
||||
echo -e "$DIR_MADE_MSG" ;}
|
||||
setup() {
|
||||
mkdir "$DIR" &&
|
||||
touch {"$EXAMPLE_DECK","$HIGH_SCORE","$REVIEW_LOG"} &&
|
||||
echo "$DECK_TEMPLATE" >>"$EXAMPLE_DECK" &&
|
||||
echo -e "$DIR_MADE_MSG"
|
||||
}
|
||||
|
||||
# Test if .local/share exists and wether to offer setup process
|
||||
if [ ! -d "$DIR" ]; then
|
||||
|
|
@ -128,7 +129,7 @@ if [ ! -d "$DIR" ];then
|
|||
case "$RESPONSE" in
|
||||
[QqNn]) exit 0 ;;
|
||||
[Yy]) setup && exit 0 ;;
|
||||
*) echo -e "invalid choice, please select either ${LGREEN}y${NC} or ${LRED}n${NC}" && exit 1 ;;
|
||||
*) >&2 echo -e "invalid choice, please select either ${LGREEN}y${NC} or ${LRED}n${NC}" && exit 1 ;;
|
||||
esac
|
||||
fi
|
||||
|
||||
|
|
@ -137,26 +138,21 @@ fi
|
|||
|
||||
# If there are no flashcard decks available return user to starting location
|
||||
# while also displaying explanatory text of issue
|
||||
if [ "$(find . -maxdepth "$SEARCH_DEPTH" -iname "*.csv" | wc -l)" = 0 ]; then
|
||||
echo -e "$NO_DECKS" && cd "$PWD" && exit 1
|
||||
fi
|
||||
[ "$(find . -maxdepth "$SEARCH_DEPTH" -iname "*.csv" | wc -l)" = 0 ] &&
|
||||
>&2 echo -e "$NO_DECKS" && exit 1
|
||||
|
||||
# if highscore file was removed, remake it.
|
||||
if [ ! -e "$HIGH_SCORE" ]; then
|
||||
touch "$HIGH_SCORE"
|
||||
fi
|
||||
[ ! -e "$HIGH_SCORE" ] && touch "$HIGH_SCORE"
|
||||
|
||||
# if reviewed file was removed, remake it.
|
||||
if [ ! -e "$REVIEW_LOG" ]; then
|
||||
touch "$REVIEW_LOG"
|
||||
fi
|
||||
[ ! -e "$REVIEW_LOG" ] && touch "$REVIEW_LOG"
|
||||
|
||||
print_usage() {
|
||||
echo -e "\n${LCYAN}fla.sh --- Flash card system by Bryan Jenks${NC} ${LBLUE}<BryanJenks@protonmail.com>${NC}\n\n${YELLOW}${BOLD}Usage:${NC}\n\t${GREEN}flash -h:${NC} Print this help text\n\t${GREEN}flash -i:${NC} Print Information about the flashcard system\n\t${GREEN}flash -v:${NC} Print version Number\n\t${GREEN}flash -p [BINARY]:${NC} Change the previewer when selecting decks.\n\t\tDefault: ${GREEN}bat${NC}\n\t\tSupported: ${GREEN}bat${NC}, ${GREEN}cat${NC}\n"
|
||||
}
|
||||
|
||||
print_info() {
|
||||
echo -e "\nThis flash card system works via colon ${YELLOW}:${NC} seperated ${YELLOW}.csv${NC} files\n
|
||||
echo -e "\nThis flash card system works via colon ${YELLOW}:${NC} separated ${YELLOW}.csv${NC} files\n
|
||||
with entries that look like this: ${LGREY}category:question:answer:0${NC}\n
|
||||
These ${YELLOW}.csv${NC} files should be stored in your
|
||||
|
||||
|
|
@ -202,18 +198,17 @@ while getopts 'hivp:' flag; do
|
|||
case "${flag}" in
|
||||
h) print_usage && exit 0 ;;
|
||||
i) print_info && exit 0 ;;
|
||||
v) echo -e "\n${YELLOW}fla.sh Current Version:${NC} ${RED}1.1${NC}\n" && exit 0 ;;
|
||||
p) if [[ $(command -v "$OPTARG" 2>&1) ]]; then PREVIEWER=$OPTARG; else echo "Unable to find previewer $OPTARG. Exiting..." && exit 1; fi ;;
|
||||
v) echo -e "\n${YELLOW}fla.sh Current Version:${NC} ${RED}1.2${NC}\n" && exit 0 ;;
|
||||
p) { [[ $(command -v "$OPTARG" 2>&1) ]] && PREVIEWER=$OPTARG; } || >&2 echo "Unable to find previewer $OPTARG. Exiting..." && exit 1 ;;
|
||||
*) print_usage && exit 1 ;;
|
||||
esac
|
||||
done
|
||||
|
||||
|
||||
# Set some parameters for preview command used by FZF
|
||||
while [ -z "$PREVIEWER_PARAMTERS" ]; do
|
||||
case "$PREVIEWER" in
|
||||
bat) PREVIEWER_PARAMTERS="--theme='Solarized (dark)' --style=numbers --color=always" ;;
|
||||
cat) PREVIEWER_PARAMTERS="--number" ;;
|
||||
cat) PREVIEWER_PARAMTERS="-b" ;;
|
||||
*) echo -e "${RED}$PREVIEWER${NC} is not a valid previewer. Use '${GREEN}bat${NC}' or '${GREEN}cat${NC}'. Falling back on default...\n" && read -r -s -p 'Press [Enter] to continue...' && echo -e "\n" && PREVIEWER='bat' ;;
|
||||
esac
|
||||
done
|
||||
|
|
@ -242,7 +237,7 @@ ${ORANGE}${BOLD}Cards Reviewed:${BOLD}${NC}\t$COUNTER
|
|||
${LGREY}Category:${NC} ${q[0]}
|
||||
___________________________________________________________
|
||||
|
||||
$(if [ ${#QUESTION} -lt 59 ]; then printf "%$(( ( 59 - ${#QUESTION} ) / 2 ))s"; fi)$QUESTION"
|
||||
$([ ${#QUESTION} -lt 59 ] && printf "%$(((59 - ${#QUESTION}) / 2))s")$QUESTION"
|
||||
|
||||
}
|
||||
|
||||
|
|
@ -259,9 +254,7 @@ add_usage_entry(){
|
|||
# If no deck is selected in fzf menu
|
||||
# return user to start location
|
||||
# and exit quietly
|
||||
if [ -z "$DECK" ]; then
|
||||
clear && cd "$PWD" && exit 1
|
||||
fi
|
||||
[ -z "$DECK" ] && clear && exit 1
|
||||
|
||||
main() {
|
||||
IFS=$':'
|
||||
|
|
@ -279,15 +272,13 @@ ${LGREY}──────────────── Press [Enter] to contin
|
|||
done
|
||||
clear
|
||||
print_head
|
||||
if [ "$NEXT" = q ] || [ "$NEXT" = Q ]; then
|
||||
add_usage_entry && cd "$PWD" && clear && exit 0
|
||||
fi
|
||||
{ [ "$NEXT" = q ] || [ "$NEXT" = Q ]; } && add_usage_entry && clear && exit 0
|
||||
|
||||
ANSWER=$(echo "${q[2]}" | fold -w 59)
|
||||
|
||||
echo -e "___________________________________________________________
|
||||
|
||||
$(if [ ${#ANSWER} -lt 59 ]; then printf "%$(( ( 59 - ${#ANSWER} ) / 2 ))s"; fi)$ANSWER
|
||||
$([ ${#ANSWER} -lt 59 ] && printf "%$(((59 - ${#ANSWER}) / 2))s")$ANSWER
|
||||
|
||||
${WHITEBG}${WHITE}===========================================================${NC}
|
||||
|
||||
|
|
@ -302,9 +293,8 @@ ${LGREY}Select a number to continue, or${NC} ${LRED}Q${NC} ${LGREY}to quit...${N
|
|||
# shellcheck disable=SC2162
|
||||
read -sn 1 DIFFICULTY_SCORE
|
||||
done
|
||||
if [ "$DIFFICULTY_SCORE" = q ] || [ "$DIFFICULTY_SCORE" = Q ]; then
|
||||
add_usage_entry && cd "$PWD" && clear && exit 0
|
||||
fi
|
||||
{ [ "$DIFFICULTY_SCORE" = q ] || [ "$DIFFICULTY_SCORE" = Q ]; } &&
|
||||
add_usage_entry && clear && exit 0
|
||||
clear
|
||||
|
||||
COUNTER="$((COUNTER + 1))" # Increment count for card review count increment
|
||||
|
|
@ -340,19 +330,15 @@ ${LGREY}Select a number to continue, or${NC} ${LRED}Q${NC} ${LGREY}to quit...${N
|
|||
|
||||
# Update item score for each flashcard item
|
||||
## Remove forward slashes in the Questions and answers
|
||||
QUESTION_REGEX=$(sed "s/\(\/\|\[\|\]\|\*\)/\\\\\1/g" <<< "${q[1]}")
|
||||
ANSWER_REGEX=$(sed "s/\(\/\|\[\|\]\|\*\)/\\\\\1/g" <<< "${q[2]}")
|
||||
|
||||
QUESTION_REGEX="$(sed "s/\(\/\|\[\|\]\|\*\)/\\\\\1/g" <<<"${q[1]}")"
|
||||
ANSWER_REGEX="$(sed "s/\(\/\|\[\|\]\|\*\)/\\\\\1/g" <<<"${q[2]}")"
|
||||
sed -i "s/${q[0]}:$QUESTION_REGEX:$ANSWER_REGEX:${q[3]}/${q[0]}:$QUESTION_REGEX:$ANSWER_REGEX:$NEW_ITEM_SCORE/g" "$DECK"
|
||||
# If no highscore currently set, set it.
|
||||
if [ -z "$(cat "$HIGH_SCORE")" ]; then
|
||||
echo "$COUNTER" > "$HIGH_SCORE"
|
||||
fi
|
||||
[ -z "$(cat "$HIGH_SCORE")" ] && echo "$COUNTER" >"$HIGH_SCORE"
|
||||
|
||||
# If Cards Reviewed > Current High Score, Update
|
||||
if [ "$COUNTER" -gt "$(cat "$HIGH_SCORE")" ]; then
|
||||
echo "$COUNTER" > "$HIGH_SCORE"
|
||||
fi
|
||||
|
||||
[ "$COUNTER" -gt "$(cat "$HIGH_SCORE")" ] && echo "$COUNTER" >"$HIGH_SCORE"
|
||||
}
|
||||
|
||||
while true; do
|
||||
|
|
|
|||
Loading…
Reference in New Issue