<div align="center"> <br> <img src="./resources/icons/hicolor/scalable/apps/icon.svg" width="150" /> <h1>Oboete</h1>

<h3>A flashcards application for the COSMIC™ desktop</h3> <img alt="Folders Window Dark" width="320" src="./resources/screenshots/folders-dark.png"/> <img alt="Flashcards Window Dark" width="320" src="./resources/screenshots/flashcards-dark.png"/> <img alt="Study Window Dark" width="320" src="./resources/screenshots/study-dark.png"/>

<br><br>

<a href="https://flathub.org/apps/dev.mariinkys.Oboete"> <img width='240' alt='Download on Flathub' src='https://flathub.org/api/badge?locale=en'/> </a> </div>

Notes

This project is related to my other flashcard project, if you want Chinese or Japanese flashcards you can check it out!

[!WARNING] Right now RTL languages are not well supported, please take a look at #6 for more information

Anki Importing Support

Please Look at: ANKI_IMPORTING

Installation

git clone https://github.com/mariinkys/oboete.git
cd oboete
cargo build --release
sudo just install

Development Notes

In order to build the Flatpak, first you need to create the 'cargo-sources.json' file, for that we'll use this python script, from flatpak-builder-tools, remember that the 'tomlkit' and 'aiohttp' python modules are needed (they can be installed with pip).

Once you have that, with the python script in the root of the project, you can start with:

python3 flatpak-cargo-generator.py Cargo.lock -o cargo-sources.json

This will create the needed 'cargo-sources.json' file. Then you already can build and install the Flatpak with:

flatpak-builder --user --install --force-clean build-dir dev.mariinkys.Oboete.json

You can also build the Flatpak and not install it with:

flatpak-builder --force-clean build-dir dev.mariinkys.Oboete.json

Useful resources include: Flatpak Docs. Remember that whenever the dependencies change/are updated the 'cargo-sources.json' file needs to be rebuilt.

Copyright and Licensing

Copyright 2024 © Alex Marín

Released under the terms of the GPL-3.0