-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
30 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |