https://github.com/rpearce/bashcards
Practice flashcards in your terminal
https://github.com/rpearce/bashcards
bash cli flashcards hacktoberfest nix practice-flashcards terminal
Last synced: about 1 month ago
JSON representation
Practice flashcards in your terminal
- Host: GitHub
- URL: https://github.com/rpearce/bashcards
- Owner: rpearce
- License: bsd-3-clause
- Created: 2020-04-29T01:33:25.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2023-01-29T08:32:39.000Z (over 2 years ago)
- Last Synced: 2025-05-07T15:06:14.040Z (about 1 month ago)
- Topics: bash, cli, flashcards, hacktoberfest, nix, practice-flashcards, terminal
- Language: Shell
- Homepage: https://github.com/rpearce/bashcards
- Size: 62.5 KB
- Stars: 14
- Watchers: 4
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# 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](https://github.com/nixos/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](https://github.com/rpearce/bashcards/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 < spanish.bcrds
goodbye=adiós
hello=hola
I love you=Te quiero.
EOF
λ cat < 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/](./examples) folder of this
project.