diff options
author | Jedidiah Barber <contact@jedbarber.id.au> | 2021-11-07 17:42:29 +1300 |
---|---|---|
committer | Jedidiah Barber <contact@jedbarber.id.au> | 2021-11-07 17:42:29 +1300 |
commit | 2b4a710f7913c29058cbc05688c0c2f2caf881e8 (patch) | |
tree | adf9faff126c7badbc054e7bb4e4851e8c5eeb31 | |
parent | 23f65aff1efa348396d60357d5650c5fd685a667 (diff) |
Readme added
-rw-r--r-- | readme.txt | 54 |
1 files changed, 54 insertions, 0 deletions
diff --git a/readme.txt b/readme.txt new file mode 100644 index 0000000..557b769 --- /dev/null +++ b/readme.txt @@ -0,0 +1,54 @@ + + +Converter From Anki .apkg to Fresh Memory .fmd +============================================== + + + + +This is a command line utility that can convert Anki .apkg flashcard decks into +either .csv format or Fresh Memory .fmd format. Due to the limitations of those +formats, text style/formatting does not carry over well. However for simpler +decks it should be sufficient. + + + + +Dependencies: + + GNAT (GNAT.Command_Line, GNAT.Strings, GNAT.Regpat) + GNATCOLL-Core (GNATCOLL.JSON) + SQLite (C library interface) + ZipAda (UnZip) + + + + +How to build/install: + +This repository is written to use the GNAT Project Manager build tools. + +Before building this utility you must first install ZipAda as a standalone +library. Because that project does not currently have a suitable .gpr file for +that, one has been included in this repository in the zipada subdirectory. + +Afterwards, to build this utility use the following command + + gprbuild freshdeck.gpr + +And to install, use + + gprinstall -p -m freshdeck.gpr + + + + +For further information on the build tools, consult + + https://docs.adacore.com/gprbuild-docs/html/gprbuild_ug.html + +For further information on the structure of Anki decks, consult + + https://github.com/ankidroid/Anki-Android/wiki/Database-Structure + + |