> ## Documentation Index
> Fetch the complete documentation index at: https://developer.supernotes.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Supervocab

<a href="https://github.com/Jotrorox/supervocab/releases/latest" target="_blank">
  <img height="200" noZoom src="https://img.shields.io/github/v/release/Jotrorox/supervocab?sort=semver" />
</a>

A **unofficial** spaced Repetition add-on to [Supernotes](supernotes.app).

## About the project

The idea of the project originated in early June 2023, when I started using [Supernotes](supernotes.app), for my daily notes. I started building my second brain and learned to really love it. But the App has a flaw, not a big one but in my opinion there is a feature that for students is unavoidable. Which is spacial repetition and please don't mistake me, as a student the app is awesome, but I really love spaced repetition systems that integrate into my note-taking, like remnote. So I decided to build something like this on my own. And thanks to the awesome support by [Connor](https://github.com/acnebs) and [Tobias](https://github.com/tobeagram), I was able to quickly start developing on this project.

## Usage

### For newest/development version

1. Install the rust toolchain from [rustup.rs](https://rustup.rs).
2. Install git using git for windows or your package manager of choice
3. Download the repository: `git clone https://github.com/Jotrorox/supervocab`
4. Run the Program using: `cargo run` or using the nix-shell and `run`
5. Build the Program using: `cargo build`

### For stable version

1. Download the latest stable release from the [releases tab](https://github.com/Jotrorox/supervocab/releases)
2. Execute the program

## Contributing (Always welcome)

1. Fork it ([https://github.com/Jotrorox/supervocab/fork](https://github.com/Jotrorox/supervocab/fork))
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request

## Contributors

* [Jotrorox](https://github.com/Jotrorox) - creator and maintainer
