From 37c7df5cb4ed62b8be180e4ccd686e0fea82a233 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ga=C3=A9tan=20Muck?= Date: Mon, 24 Jul 2023 06:27:31 +0200 Subject: [PATCH 1/2] Update README.md --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index 5496e6c..f8fc319 100644 --- a/README.md +++ b/README.md @@ -15,6 +15,8 @@ ### Reviews durations +![Reviews durations](https://github.com/gaetanmuck/obsidian-flashcard-learning/assets/26961057/aa5b9edb-da0f-44d3-a182-5f6397b7c0a1) + #### Multiple reviews in a single day A review is not managed by time, but rather by the advancement in a review: if a review is short, then another can be started right after. @@ -37,8 +39,12 @@ So when the flashcard is presented with the country name, what's expected is not In this plugin, there is the possibility to hint (actually, it is more like a description of what is expected) the answer. So that when a flashcard is presented, the expectation is clear. And if the descriptions are correctly set, it works both ways! +![Expectation description](https://github.com/gaetanmuck/obsidian-flashcard-learning/assets/26961057/ef83759f-a127-4040-9703-752c0e066f68) + ### Learning +![Learning](https://github.com/gaetanmuck/obsidian-flashcard-learning/assets/26961057/620629bb-08d9-431c-93b7-98c55d4632f2) + #### Best known, less shown When a flashcard is correctly answered, it will be lesser presented. And the more correct answer in a row, the more the rarity of the presentation increases. @@ -53,6 +59,8 @@ On the contrary, when a flashcard is wrongly answered, level will be reset to 0, #### Create cards with the helper +![Create cards with the helper](https://github.com/gaetanmuck/obsidian-flashcard-learning/assets/26961057/2e319158-4eeb-48c6-b732-a5025ad59436) + Flashcard can be created with the command `Create new Flashcard`. This will show a modal where information can be set, and create the flashcard where the cursor was placed on command execution. There is the possibility to help the creation of flashcards. @@ -62,6 +70,8 @@ On creation, the plugin also check if the properties `flashcard: true` is also s #### Create cards manually +![Create card manually](https://github.com/gaetanmuck/obsidian-flashcard-learning/assets/26961057/c61151db-5b1f-4aef-b6b6-8c005873a181) + Once the syntax understood, flashcards can be created manually (or generating by a script for instance), and will be treated by the plugin according to provided information. In that scenario, the property `flashcard: true` has to be added also manually in the frontmatter YAML. #### New cards @@ -78,10 +88,15 @@ The plugin provided two inputs: - One ribbon icon, to have sum up of what the plugin is aware of and to start (or resume) reviews - One command that can be execute in a file (advised on a new line!) to easily create a flashcard +![Commands - modal](https://github.com/gaetanmuck/obsidian-flashcard-learning/assets/26961057/acb3cb7f-212b-473b-a31c-3180c8327485) +![Commands - ribbon](https://github.com/gaetanmuck/obsidian-flashcard-learning/assets/26961057/589c5c71-b630-465d-b70c-15e1481bfe82) + ## Home screen See screen shots for more details. +![Home screen](https://github.com/gaetanmuck/obsidian-flashcard-learning/assets/26961057/12c94f0d-39c6-4a0f-90b6-0a482476a55c) + ## Thanks If you find value in this plugin and would like to show your support, you can [Buy Me A Coffee](https://www.buymeacoffee.com/gaetanmuck), it would be grateful. From 36cd7d1fef60aea6a62981c1f051d0788c81790f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ga=C3=A9tan=20Muck?= Date: Mon, 24 Jul 2023 06:35:43 +0200 Subject: [PATCH 2/2] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index f8fc319..e38414b 100644 --- a/README.md +++ b/README.md @@ -78,7 +78,7 @@ Once the syntax understood, flashcards can be created manually (or generating by When learning a field, it might have some times when the speed of creating new cards is much higher than the speed of learning, and it can be discouraging to have hundreds of things to learn. Even this can become counter productive because these hundreds of new information are not presented with the spaced presentation they deserve. So to tackle this point, on creation, a card is set as "new", and will not be added to current review. -But, at the end of each review, according to the plugin setting, a certain number of new cards will be added to next review (randomnly chosen across all news). +But, at the end of each review, according to the plugin setting, a certain number of new cards will be added to next review (randomly chosen across all news). So that the review size is kept at a reasonnable size. When creating manually cards, do not forget to set level to -1 to enable this feature.