Releases: alanxoc3/concards
Files Option, Stat Command, & Review Logic
I added an option to concards that lists all the files that contain flashcards. This is useful if you run flashcards on a folder and want to see which files in that folder actually contain cards.
There is now an 's' keybinding available while reviewing cards. This shows some stats about the current card, such as how many times it has been reviewed.
I changed the card ordering logic. Cards that have never been passed off are now first to be reviewed. This way you can still review new cards even if you're behind. There is also a slight improvement to the sm2 algorithm for what happens if the current streak is zero.
Concards now relies on the cobra library. Cobra can handle flag only based CLIs, where as the previous argparse library couldn't.
And finally, Concards has go's module support now, so it can both have stable branch builds and run on go 1.16+ now.
Hash Syntax & Cloze Functionality
I switched the starting and ending of the concard block to be #: ... :#
now instead of @> <@
. This makes cards look much cleaner. Also the @>
is used in postgress. I looked at :>
, but that's used in haskell. Ultimately, I feel like the hash syntax looks the best out of all of them.
Also as part of this release, cloze syntax is implemented now. The readme received a big rewrite going into depth on the syntax of concards, including the new cloze syntax.
There is a transition script in the scripts folder. The transition script only gives an idea for how to transition over from the @>
syntax. This change only affects note files, not meta files.
File Format, Card History, & 2 Input
I made a major refactor in the project and improved all the tests for this release. I also introduced breaking changes in this release. The ~/.concards-meta
file is now ~/.config/concards/predict
. Also the file format is different, so see the scripts
folder for a script to help you transition & see README.md
to understand the new format.
There is a new file that concards now saves under ~/.config/concards/outcome
. This file has the history of every time you review a card. Currently concards is only writing to this file and not actually using it, but there are many useful future applications for this file such as displaying detailed stats and applying machine learning.
The last big change is that concards accepts 2 inputs instead of 3 now. 3 inputs was just confusing me when I was studying.
Lastly, I changed the way that cards are reviewed. This means a slight change on the UI, the way cards reappear when reviewing them, how the -d
argument functions now, and how spaced repetition algorithms input and output data.
Added Escape Character Support
All concards keywords can now be escaped and appear in the UI. This means it's possible to add any character/word to concards now.
New Pipe Syntax
This release changes the @
sign that was previously used for answers to a |
. Also, I made the CI system able to add the version into the executable now, so concards will tell the correct version now. This release is not backwards compatible with v0.4.0, so I created a bash script to help with transitioning old cards and meta file to the new format. You can find this script in the scripts
folder.
Reviewing Other Sides
Now you can use the --sides
or -s
to add the other sides of flashcards to your review session. I also moved the deployment file generation to Travis CI, instead of Github Actions.
Filename Visible & More Binaries
The only thing different about this release is continuous integration via github actions (more binaries available) and the footer at the bottom of the screen includes the file name now.
Related issues: #1
First Release After Major Update
The syntax and philosophy behind concards is now different, though the UI feels the same. Concards stores metadata in it's own file now. See the README.
I'm including a binary file here too.
First Concards Iteration
This was a port of the flashcard syntax I originally had. The syntax for a card looks something like this:
## group1 GROUP2 group_3
question1
answer1 (3 spaces)
question2
still question2
answer2 (3 spaces)
And meta data is stored next to the card in the text file with this release. Later releases give a separate meta data file for cards.