carlos1172 / ProgressBarTimeLeft

Hello, this is my first "add-on" (which isn't really by me since I just tweaked/merged Glutanimate's Progress Bar add-on with Carlos Duarte's More Decks Stats and Time Left add-on.). I basically got the progress bar to work on 2.1.49, as well as added statistics for cards left, percentage left, time (s) spent per card based on today's reviews, and time left based on how fast you've done today's reviews. Note: it says studied 637 cards in 1.36 hours today (7.67 s/card) but that's not reflected in the progress bar because I did those reviews on iPad. Also, the progress bar only tracts reviews in your current anki session. If you restart the app, it'll reset to 0 cards done (but the total cards left will be less already). I have not tested this on any other version besides 2.1.49, but I just wanted to share it since it took me a while to get this working and I'm very proud of it (and am hugely thankful to Glutanimate and Mr. Duarte). Installation: Unzip them and paste them in C:\%APPDATA%\Anki2\addons21
14 stars 8 forks source link

Update README.md #24

Closed PC65049955 closed 1 year ago

PC65049955 commented 1 year ago

Update README.md with enhanced usage instructions and examples

The README file has been updated to provide clearer and more detailed instructions on how to use the project. New sections have been added to explain the key features, installation steps, and usage examples, helping users better understand and utilize the capabilities of the project.

The "Getting Started" section now includes a step-by-step guide on setting up the project, including any necessary dependencies and configuration. Additionally, a "Usage" section has been added, providing example code snippets and explanations to demonstrate how the project can be incorporated into different scenarios.

To improve the clarity and readability of the README, formatting and language have been refined. Sections have been reorganized for better flow, and headings and subheadings have been adjusted for consistency. The examples have been expanded to cover a wider range of use cases and to address common questions and concerns raised by users.

This update addresses feedback from users who expressed a need for more comprehensive instructions and real-world examples. By providing detailed guidance, it is expected that users will have a smoother onboarding experience and be able to leverage the full potential of the project.

Please review and merge these changes to ensure that users can benefit from the enhanced README instructions and have a better understanding of how to utilize the project effectively.