Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
nvh0412 committed Apr 24, 2024
1 parent e1b4737 commit 07e39df
Showing 1 changed file with 11 additions and 9 deletions.
20 changes: 11 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,22 @@
# Ngurra

Ngurra 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.
Ngurra (`Ngurra` signifies `Home` in the Aboriginal language of Australia, which holds significant meaning for me as my second home country.) 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.

![Screenshot 2024-02-22 at 10 48 48 pm](https://github.com/nvh0412/anki-rs/assets/1973623/d74a90cd-d8e4-42ce-833d-ed51c373d42e)
## Showcase

https://github.com/nvh0412/anki-rs/assets/1973623/b67b55d4-f8db-422d-91f8-2092b280f364

## Features

- Deck management: Create and delete flashcard decks.
- Flashcard management: Add, flashcards within decks.
- Learn flashcards: Study flashcards using various learning modes.
- Flashcard management: Add flashcards within decks.
- Learn flashcards: Study flashcards using various learning modes. (Use SuperMemo-2 Algorithm as this Project is just a hobby project)

## 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:
Once you have Rust installed, you can clone the Anki-rs repository.

### Running

Expand All @@ -26,7 +28,7 @@ cargo run

Shout out to these open sources:

- Anki
- GPUI: Zed's UI framework
- Loungy: The Rust launcher in the vein of Spotlight, Alfred, Raycast.
- Catppuccin: The theme that makes everything look good
- [Anki](https://github.com/ankitects/anki)
- [GPUI: Zed's UI framework](https://github.com/zed-industries/zed)
- [Loungy: The Rust launcher in the vein of Spotlight, Alfred, Raycast.](https://github.com/MatthiasGrandl/Loungy)
- [Catppuccin: The theme that makes everything look good](https://github.com/catppuccin/catppuccin)

0 comments on commit 07e39df

Please sign in to comment.