memchan

README

memchan

Description

Is a flashcard app with terminal GUI

⚡️ The project is in rapid stage of development, issues and critics are welcome.

Table of contents

• memchan
  • Description
  • Table of contents
  • Getting started
    • Installation
      • Go
    • Usage
    • Usecases
      • Add deck
      • etc
  • ✨ Inspired by
  • Used libraries

Getting started

See the documentation for further details.

Installation

Go

go install github.com/k1gabyt0/memchan@latest

Usage

Call memchan in you terminal

memchan

If you don't want to persist flashcard data on disk then you can use:

memchan --dry-run

This ^ usage is recommended for testing purposes.

Type to get list of available commands:

memchan help

TUI flashcard application to manage and memorize cards

Usage:
  memchan [flags]
  memchan [command]

Available Commands:
  completion  Generate the autocompletion script for the specified shell
  help        Help about any command
  info        Display info about memchan

Flags:
  -h, --help       help for memchan
      --dry-run    Don't persist data on disk

Use "memchan [command] --help" for more information about a command.

Usecases

Add deck

etc

TODO MEM-50 Add more

✨ Inspired by

• https://github.com/jesseduffield/lazygit
• https://github.com/ankitects/anki

Used libraries

• bubbletea - for terminal UI
• cleanenv - to use configs and env vars
• flashcard - library for manipulating flashcards
• vhs - to create tutorial gifs explaining application usecases