Skip to content

Commit

Permalink
chore: Add README
Browse files Browse the repository at this point in the history
  • Loading branch information
nvh0412 committed Feb 22, 2024
1 parent 1bb6ccf commit 0c4f887
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# Anki-rs

Anki-rs is a Rust project that aims to clone the popular flashcard application Anki. It is a hobby project created to practice Rust programming language and explore the development of flashcard applications.

## Features

- Deck management: Create, edit, and delete flashcard decks.
- Flashcard management: Add, edit, and remove flashcards within decks.
- Search cards: Search for specific flashcards based on keywords or tags.
- Learn flashcards: Study flashcards using various learning modes.

## Installation

To use Anki-rs, you need to have Rust installed on your system. If you don't have Rust installed, you can get it from the official Rust website: [https://www.rust-lang.org/](https://www.rust-lang.org/)

Once you have Rust installed, you can clone the Anki-rs repository:

### Running

```bash
cargo run
```

## Credit

Shout out to these open sources:

- GPUI: Zed's UI framework
- Loungy: The Rust launcher in the vein of Spotlight, Alfred, Raycast.
- Catppuccin: The theme that makes everything look good

0 comments on commit 0c4f887

Please sign in to comment.