diff --git a/misc/ankiweb_description.html b/misc/ankiweb_description.html index 7721b0c..d40b2bb 100644 --- a/misc/ankiweb_description.html +++ b/misc/ankiweb_description.html @@ -1,9 +1,23 @@ -CrowdAnki is a plugin for http://ankisrs.net/ that allows users to import and export decks/notes and all relevant information in a hierarchical JSON format. The main purpose is to facilitate crowdsourcing for Anki decks and notes. +CrowdAnki is a plugin for http://ankisrs.net/ that allows users to import and export decks/notes and all relevant information in a hierarchical JSON format. The main purpose is to facilitate crowd-sourcing for Anki decks and notes. -Suggested collaboration workflow +Starting with version 0.6 it also features a close integration with Git. +Providing you with an ability to automatically maintain history of edits for your decks. +See more details below. -The current workflow could be described as following: +Please note that I can't reply to your comments here (and I'm not getting notified about them). If you want to get in + touch - please ping me on Github: https://github.com/Stvad/CrowdAnki + +If you would like to support the plugin - please consider becoming a Patron! + + +Suggested collaboration workflow (a more detailed version is available on Github): + +The current workflow could be described as following: Export - -To perform the export go to menu File>Export - +To perform the export go to menu File>Export Select the deck (note: export of "All decks" is not supported, you need to select a specific deck) and the export format "CrowdAnki JSON representation". After pressing the Export button - select directory where the result should be stored. Import - -To perform the import go to menu File>"CrowdAnki: Import from disk" and select the directory where the deck is stored. +To perform the import go to menu File>CrowdAnki: Import from + disk and select the directory where the deck is stored. Import from Github -To get the deck from Github go to menu File>"CrowdAnki: Import from Github" and enter Github username and repository name in suggested format. -So, for example, to get my git deck (https://github.com/Stvad/Software_Engineering__git) you would need to enter Stvad/Software_Engineering__git. +To get the deck from Github go to menu File>"CrowdAnki: Import from Github" and enter Github username and repository name in suggested format. +So, for example, to get my git deck (https://github.com/Stvad/Software_Engineering__git) you would need to enter Stvad/Software_Engineering__git. Things to note for the Import: - -To get more information or get in touch with author, please visit https://github.com/Stvad/CrowdAnki \ No newline at end of file +To get more information or get in touch with author, please visit https://github.com/Stvad/CrowdAnki + +Snapshots +CrowdAnki can help you preserve the history of edits for your decks. +It does this by exporting them in a specified location and creating a git commit each time you do a snapshot. +You can take snapshots manually via File > CrowdAnki: Snapshot menu action. +Or you can enable automated snapshots in plugin configuration. You can find more details on how to do it here. +Other things you can configure is the location of the snapshot and what decks should be included into it. + +Please note that I can't reply to your comments here (and I'm not getting notified about them). If you want to get in + touch - please ping me on Github: https://github.com/Stvad/CrowdAnki \ No newline at end of file