Merge branch 'master' of https://github.com/gaetanmuck/obsidian-flash…

…card-learning

README.md

@@ -1,7 +1,7 @@
 # Flashcard learning
 
 Flashcard-Learning is an Obsidian plugin made to learn things and remember them. 
-Put your flashcards where you notes lie thanks to Obsidian, and create card out of your note to remember their substance, key concepts, or just knowledge like countries main cities.
+Put your flashcards where you notes lie thanks to Obsidian, and create card out of your notes to remember their substance, key concepts, or just knowledge.
 
 ## Main concepts
 
@@ -23,19 +23,19 @@ Deck is parent of Flashcard. Each Flashcard should belong to one Deck.
 
 This is why, by default, all Flashcards belonging to the Deck « No Deck » will not be treated. If you have such cards in your vault, you should search with Obsidian the string « No deck » and replace them with the Deck you want to attribute them.
 
-How are those « No deck » card existing? If you delete a Deck via the plugin settings, and you still have card in that deck, rather to also delete the card with it, they will be changed to « No deck ». That is so to avoid to delete information to fast. Another possibility of having « No deck » is if you create card manually: it is possible to directly, in your Obsidian notes, create Flashcard with the right syntax. Then, when the home modal will load (by pressing the book icon on the ribbon) it will parse all Flashcards and attribute « No deck » to all Flashcard with an non existing deck. 
+How are those « No deck » card existing? If you delete a Deck via the plugin settings, and you still have card in that deck, rather to also delete the card with it, they will be changed to « No deck ». That is so to avoid to delete information to fast. Another possibility of having « No deck » is if you create cards manually: it is possible to directly, in your Obsidian notes, create Flashcard with the right syntax. Then, when the home modal will load (by pressing the book icon on the ribbon) it will parse all Flashcards and attribute « No deck » to all Flashcard with an non existing deck. 
 
 Each Deck has a review index that will be incremented each time you review it.
 
 In this plugin, you also have the possibility to review all deck at once. It has then the consequence to increment indexes of all decks at once.
 
-### Description
+### Descriptions
 
 Each side of each Flashcard has a description field. This field helps the learner to know what he is asked for. For instance, if you would only have a Flashcard content with a « 1 » in it, what is expected to guess? But the description tells you « Atom: » so that you understand what you need to find, and can easily answer « Hydrogen ».
 
 #### Level
 
-All Flashcard has a level attributed. By default, on creation it has level 0. This tells how well you know a Flashcard. The more correct answer you give in a row, the higher the level will be. The level number also corresponds to the time you will have to wait before seeing this card again (if you answer correctly), or will drop to 0 (if you are wrong), and you will see this card again on next review.
+All Flashcards has a level attributed. By default, on creation it has level 0. This tells how well you know a Flashcard. The more correct answer you give in a row (about a specific Flashcard), the higher the level will be. The level number also corresponds to the time you will have to wait before seeing this card again (if you answer correctly), or will drop to 0 (if you are wrong), and you will see this card again on next review.
 
 
 ## Get started
@@ -45,14 +45,14 @@ Once you have installed it, your Obsidian vault has two new features: the first
 
 ### « Create Flashcard » command
 
-This command is available when you are editing a note in your Obsidian vault. It allows you to create a Flashcard without mistake. 
+This command is available when you are editing a note in your Obsidian vault. It allows you to create a Flashcard without syntax mistake. 
 
-On activation this command will open a modal containing a form with all the information needed to create a Flashcard. Once you have filled everything and validate the form, the plugin will add two new lines where your cursor was to create two Flashcards out of the information you provided. One good solution could be to have a Flashcard section in your notes to put all Flashcards there, but that is just an idea, you manage your notes as you wish.
+On activation this command will open a modal containing a form with all the information needed to create a Flashcard. Once you have filled everything and validate the form, the plugin will add two new lines where your cursor was to create two Flashcards out of the information you provided. One good habbit could be to have a Flashcard section in your notes to put all Flashcards there, but that is just an idea, you manage your notes as you wish.
 
-If you understand what this commands produce, you could also create Flashcards manually with your keyboard, or other techniques you know about (copy/paste, code, ...). Maybe it is more suitable for you when you would create a bunch of Flashcards in one time. You could also put all Flashcards of a Deck in a dedicated file, that is up to you.
+If you understand what this commands produce, you could also create Flashcards manually with your keyboard, or other techniques you know about (copy/paste, code, ...). Maybe it is more suitable for you when you would create a bunch of Flashcards in one time. You could also put all Flashcards of a Deck in a dedicated file, but again, this is up to you.
 
 One counter part of creating a lot Flashcard in one time could be to have a lot of new information in the next review, and that is maybe not optimal to learn correclty. 
-To take this problem away you could create only a certain number of new Flashcard a day, or « deactivate » some of them by changing the string (like writing `-FLASHCARD...` instead of `FLASHCARD...`), but again, this is up to you.
+To take this problem away you could create only a certain number of new Flashcard a day, or « deactivate » some of them by changing the string (like writing `-FLASHCARD...` instead of `FLASHCARD...`).
 
 ### Book button in the ribbon
 
@@ -61,11 +61,11 @@ This button is the place to start reviews. When clicking on it, you will be info
 
 ## Other existing solutions
 
-There is other existing solutions across the web to handle Flashcard learning with the more popular of them [Anki](https://apps.ankiweb.net/). This plugin does not have the pretention of being better than these other solutions. I (the developer of this plugin) was just not 100% satisfied with what he used and tried accross the years. And it came a time where I discovered that developping an Obsidian plugin is not so hard, so I decided to invest the time to make a Flashcard app that answers my need and that would be in the same application my Second Brain is! I also decided to share it with everyone, in case it also correspond to the need of others, so if you read until here, I consider it already worth the investment.
+There is other existing solutions across the web to handle Flashcards with the more popular of them [Anki](https://apps.ankiweb.net/). This plugin does not have the pretention of being better than these other solutions. The developer of this plugin (me) was just not 100% satisfied with what he used and tried accross the years. And it came a time where he discovered that developping an Obsidian plugin is not so hard, so he decided to invest the time to make a Flashcard app that answers his need and that would be in the same application his Second Brain is! He also decided to share it with everyone, in case it also corresponds to the need of others, so if you read until here, he considers the work already worth the investment.
 
-In case you would give my investment event more worth, here is a link to do it:
+In case you would give his investment even more worth, here is a link to do it:
 
 <a href="https://www.buymeacoffee.com/gaetanmuck" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/default-orange.png" alt="Buy Me A Coffee" height="41" width="174"></a>
 
 
-Cheers!
+Happy learning!