flash-client

Crates.ioflash-client
lib.rsflash-client
version0.1.0
sourcesrc
created_at2022-09-26 23:35:35.278063
updated_at2022-09-26 23:35:35.278063
descriptionA TUI application for studying with flash cards.
homepage
repositoryhttps://github.com/Peter-Lande/flash-client
max_upload_size
id674588
size97,583
Peter (Peter-Lande)

documentation

README

flash-client

A pure Rust TUI for making, using, and sharing flash cards. Flash aims to be a simplistic and useful study tool. This is my first major project in Rust and any feedback would be greatly appreciated. Happy studying!

Installation

Currently, Flash can only be installed via cargo using the command,

Cargo

First, install Rust (using the recommended rustup installation method) and then

cargo install flash-client

This method will build the binary from source.

To update, run the same command again.

Usage

Simply run the binary flash-client.

Features

  1. Easy to use UI that allows for navigating between decks
  2. Allows for studying decks
  3. Creation of new decks locally
  4. Editing and adding of decks, cards, and sections
  5. Deleting decks and cards
  6. Customize save locations in app (planned)
  7. Shuffles decks based on how well you understand the content (planned)
  8. Access remote servers to download and share decks (planned)

Development

Currently, I am using this application for my learning and will not accept PRs. If you happen to find a bug, please make a issue and I will address it as soon as possible.

Commit count: 40

cargo fmt