Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #495

Merged
merged 13 commits into from
Oct 18, 2023
Merged

Update README.md #495

merged 13 commits into from
Oct 18, 2023

Conversation

Expertium
Copy link
Collaborator

No description provided.

@Expertium
Copy link
Collaborator Author

@L-M-Sherlock @user1823 any suggestions and crtitique are welcome

@L-M-Sherlock
Copy link
Member

L-M-Sherlock commented Oct 15, 2023

I guess you misunderstand my words: #494 (comment)

I mean, we need to notify the users. But the notification should be concise. We can put a link of the new tutorial in the notification in the README, like #494 (comment).

@Expertium
Copy link
Collaborator Author

I thought you wanted to modify the existing tutorial. Ok, then create a new file and add a link to it to the old readme, and I'll copy the text from this PR and submit a new PR.

@L-M-Sherlock
Copy link
Member

You can still work on the current PR.

@Expertium
Copy link
Collaborator Author

The link from README to README2 doesn't work right now, but I'm sure that will be an easy fix for you.

Comment on lines +39 to +40
FSRS has been integrated into Anki. If your version of Anki is 23.10 or newer, use the built-in FSRS. Read about how to use it [here](https://github.com/open-spaced-repetition/fsrs4anki/README2.md).
If your version of Anki is 2.1.66 or older, use the standalone version.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The introduction section serves as an introduction to FSRS in general. It is not specific to the standalone version. So, I think that this message should be added to the "How to Get Started?" section.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, I think that my version of the update notification is more concise: #494 (comment)

Comment on lines +46 to +50
FSRS4Anki consists of two main parts: the scheduler and the optimizer.

- The scheduler replaces Anki's built-in scheduler and schedules the cards according to the FSRS algorithm.
- The optimizer uses machine learning to learn your memory patterns and finds parameters that best fit your review history. For details about the working of the optimizer, please read [the mechanism of optimization](https://github.com/open-spaced-repetition/fsrs4anki/wiki/The-mechanism-of-optimization).

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In my opinion, this part should be moved back to its original place. FSRS still consists of two main parts. It is just that they have been integrated into the same section of Deck Options.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But it is in it's original place, in "Introduction".

@user1823
Copy link
Collaborator

I have several suggestions for the README2, but I am not sure what is the best way to put them forward.

@L-M-Sherlock
Copy link
Member

Is it ready to merge? For above suggestion, we can improve the readme in the next PR.

@Expertium
Copy link
Collaborator Author

I'd say it's ready.

@user1823
Copy link
Collaborator

So, we can merge it. I can make further edits in a subsequent PR.

@L-M-Sherlock L-M-Sherlock added this pull request to the merge queue Oct 18, 2023
Merged via the queue into open-spaced-repetition:main with commit 9d65db9 Oct 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants