bashcards

Practice flashcards in your terminal

Note: requires bash v4

Usage

λ bashcards -d path/to/bcards/directory
What would you like to practice?
1. german
2. spanish
3. swedish
> 2
Spanish

–––––––––––––––
|             |
|  Te quiero  |
|             |
–––––––––––––––
(Press return to flip)

––––––––––––––––
|              |
|  I love you  |
|              |
––––––––––––––––
(Press return for next card)

Installation

There are a couple of different ways to use this project.

Nix

To install via nixpkgs:

λ nix-env -i bashcards

Install Script

λ /usr/bin/env bash -c "$(curl -fsSL https://raw.githubusercontent.com/rpearce/bashcards/main/install)"

Clone the Repository

λ git clone https://github.com/rpearce/bashcards.git
λ cd bashcards
λ ./bashcards -d path/to/bcards/directory

You can also use it in nix-shell:

λ nix-shell --pure
[nix-shell:~/projects/bashcards]$ man bashcards
[nix-shell:~/projects/bashcards]$ bashcards -d path/to/bcards/directory

Download a Release

Specific releases can be downloaded and used just like the Clone the Repository section above.

Creating .bcrds files

To add some Spanish and Swedish bashcards, for example, all you need to do is create two files, spanish.bcrds and swedish.bcrds, and add lines to the files that take the form key=value.

λ mkdir /path/to/bcards/directory && cd $_
λ touch spanish.bcrds swedish.bcrds
λ cat <<EOF > spanish.bcrds
goodbye=adiós
hello=hola
I love you=Te quiero.
EOF
λ cat <<EOF > swedish.bcrds
Goodbye=Adjö
Hello=Hallå
I love you=Jag älskar dig
EOF

Once your cards are in a folder somewhere, you simply tell bashcards where to find them!

λ bashcards -d path/to/bcards/directory
What would you like to practice?
1. spanish
2. swedish
>

There are example .bcrds files in the examples/ folder of this project.