A bit more documentation please?

[snoblenet]

Hi.

To set up the app, I:

• cloned the repo
• ran cargo build
• copied the executable from /target/debug/spaced to /usr/local/bin
• added an alias in my shell pointing to the executable

To start practicing, I ran the import command on an Anki file and ended up with a bunch of correct looking markdown files with names like card1.md.

But when I cd into the directory containing those files and run spaced review it just says No cards found to review.

What am I missing?

[mtoohey31]

Thanks for checking this out, and you're right, the problem is a lack of documentation. Right now, it requires cards to be in a directory (or a directory that is a descendant of one) named cards. Thinking about this now though it's not the most flexible design decision so I think I'm going to change that. I'll update this here when I do, but for now if you rename the directory the cards are in to cards, it should work.

As for improving the documentation more generally, I do plan on doing that at some point, but the app isn't quite in a finished state yet. I'm still searching for a library to parse and render the markdown, but I haven't found anything yet that's compatible with inline and block math. Once I add that feature though, documentation will be next, so I'll leave this issue open 'till then.

Let me know whether renaming the directory works for you.

[snoblenet]

Thanks for getting back to me. As it happens, my main motive for investigating spaced was model editing of my Q/A file. I'm more than happy to test myself in a GUI as long as as the file format is sensible and import/export is much easier than allowed for by any Anki plugin. And that's what I've found with Lazycard -- the Q/A file is basically just one big JSON file and import-and-replace is a one-click process, so I'm happy. But good luck with spaced.

[mtoohey31]

No worries, thanks for giving spaced a try anyway! I wasn't aware of Lazycard, thanks for mentioning it. I'm going to reopen this, cause I do need to get around to adding more documentation, but feel free to unsubscribe from it.