husterknupp / anki-heimat-flora-fauna

Anki deck of nature stuff "you should just know about"

Heimat Flora & Fauna (Anki deck)

Highly opinionated list of interesting flowers and animals. Images mostly coming from Wikipedia.

You will need the CrowdAnki Addon: https://github.com/Stvad/CrowdAnki

Share New Notes/Cards on GitHub

• ❗️ first import if you have pulled the latest & greatest from remote (notes will get lost in git if you don't run the import first)
• (if you first run the export, commit and then do a git pull, yours and other people's changes will get merged by git)
• in Anki, open "File > Export"
• as destination dir, select any directory (probably outside this project to not commit the export)
• then, the exported content will live in a directory with the same name that it has in your Anki
• however the format of the export doesn't meet the expected git repo's format yet, so run this script before commiting

$ npm run after-export -- "<your-deck-folder>"

• this has now updated the notes and media info of this project
• 👍 review and commit the changes and you're done

Import Other People's Note/Card Updates

CrowdAnki expects notes and media_files in a certain format, which includes your personal deck meta data (like learning steps). While CrowdAnki will maintain your learning progress (even when a card receives an update), this script will help to update only the cards, not meta data.

• pull the latest changes from GitHub (probably branch main)
• no need to run the export first - CrowdAnki will not remove any notes from your deck in Anki
• run the merge script 👇 , which creates an updated deck.json in the deck/ directory

$ npm run before-import -- "<your-deck-folder>"  # can be an old export - the deck meta data is the only relevant part here

• after the script did run, in Anki open "File > CrowdAnki: Import from disk"
• chose the deck/ directory
• you may leave the default settings (don't tick the fields under "Einfach" to get the updated cards)
• 👍 You're done

anki-heimat-flora-fauna's Issues

Simplify Deck Sharing

Features

• make changes in media_files & notes easier visible
• prevent user's deck meta data from overwriting each other

Maybe

• think of running things automatically on pull/push via
• add commands inside package.json for easier usage?

Clarify Import/Export Conflicts

Case	Local Changes	Remote Changes	What Happens?
"Share"	x		Import from remote -> run before-import script -> no changes in deck.json expected -> export -> expect changes in mediaFiles + notes files -> commit & push changes
"Import"		x	-------------
"Import with local changes"	x	x	❗️ CrowdAnki will remove any changes you did to existing cards in your deck in Anki - before pulling, export your anki deck and run the after-export script -> commit changes -> git pull -> resolve merge conflict (find out how your vs. remote note) -> push updates -> import other people's updates (See import section in README) - NB: Before pulling is useful so that git can show you the merge conflict, if you already have pulled, git cannot help you here and you have to inspect the git diff closely
"Export with conflicts"	x	x	-------------

CrowdAnki doesn't handle conflicts well. Always look at the diff before commiting. Never push after export right away!

• since import overwrites your note changes, export and then pull should be the process when trying to Import (unless you didn't change any note)
• import before export is only necessary when you pulled and didn't import the latest changes - exporting an old deck state will then overwrite the latest changes and the git diff will look as if you deleted stuff (which actually you didn't)
• (but if you have exported w/o import before, you should look at the git diff closely and commit only hunks that you - the rest of the changes are actually no changes, but a not-up-to-date deck state)

When updates came from remote, don't just export & commit your deck state (import first & then export or inspect the diff closely)