Examples

[gitonthescene]

Hey there,

It's pretty hard to see what this package is doing from the README. Can you provide some examples with inputs and outputs? Your examples only show how to invoke the command and not what is expected to happen.

Org-mode syntax is very flexible and it's not at all clear what information you deem useful enough to become a card. Perhaps you expect the org files to have a certain format?

Looking at the code it looks like the front of the card is the "heading" and the back is the "body" of any node. You might mention this in the README.

Regards,
-Doug

[MatejKastak]

Hello!

First of all thanks a lot for taking interest in orglearn. You are the first person who interacted with me on this project.

I totally agree with you that the README is lacking in "descriptiveness". I will try to add more documentation along with some fitting pictures/gifs.

Until then (until I have time to expand the docs) the main idea behind Anki deck generation is that you can write your notes in a single .org document. Invoke the orglearn anki input.org to generate input.apkg cards of the leaf nodes or nodes that don't have an empty body.

... the front of the card is the "heading" and the back is the "body" of any node.

You are totally right. Adding to this there are different conversion modes (this is only starting feature) for example, the "CODE" conversion mode will construct the cards with 3 fields: heading (node title) and the body will be split by \n\n\n (2 empty) lines into a front and the back. This proved to be useful when creating cards that contained the title, extended assignment (that would be on the front of the card) and the solution to the problem (on the back of the card).

Hopefully, I was able to clarify orglearn to you. I am interested in hearing what is your use-case. If you have any other suggestions or questions, please don't hesitate to contact me.

Thanks again! 👍