diff --git a/README.md b/README.md index 4de9bb2..3cdf9f3 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,56 @@ [中文](https://github.com/IAliceBobI/sy-progressive-plugin/blob/main/README_zh_CN.md) +# Progressive Learning + +I have always struggled to finish reading long documents and imported e-books. + +By chance, I learned about the basic methods and some basics of progressive learning, and wanted to give it a try, so I developed this plugin. + +The functionality of this plugin is to divide a document into small segments and read them one by one. During the reading process, you can take notes and create flashcards for future review. + +The current state of the plugin is quite basic, and I haven't used it much myself, so there are still quite a few bugs that I haven't discovered. + +Also, the functionality of the plugin may differ greatly from what you have in mind... + +As for whether using it can improve learning efficiency, let me use it for a few months first... add some features... and fix some bugs... + +Below is a brief explanation of how to use it. + +## Add Document + +**Open the plugin menu, click on "Add Current Document," then click "Start Learning."** + +After adding a document, the plugin will perform segmentation. + +If the document is large, like the one in the picture, with millions of words, the segmentation process may take a while, so please be patient. + +The segmentation process of the plugin does not modify the original text or create new documents. It only reads, counts, and builds an index. + +![Alt text](assets/addDoc.png) + +## Start Learning + +![Alt text](assets/reading.png) + +* `Equal sign (=)`: Below the equal sign is the note area, which can be preserved. Above the equal sign is the original text with remarks added by the plugin, please do not modify. +* `Current Segment 0`: Segments are numbered starting from 0, and 0 represents the beginning of a book. +* `Delete, Continue`: The notes for the current segment will not be preserved. +* `Create Flashcard, Continue`: The notes for the current segment will be preserved, and the current document will be turned into a flashcard. Finally, the original text will be deleted and a link to the original text will be added. + +## Future Plans + +Let me use it first, then make improvements... + +# Bug Reports, Suggestions + +QQ Group: 263961482 + +[Or submit issues on GitHub](https://github.com/IAliceBobI/sy-progressive-plugin/issues) + +[Or submit issues on the official forum](https://ld246.com/tag/siyuan) + +# Changelog + +## 2023-11-17 + +* First version diff --git a/README_zh_CN.md b/README_zh_CN.md index 3bef01b..e74118c 100644 --- a/README_zh_CN.md +++ b/README_zh_CN.md @@ -22,11 +22,26 @@ **打开插件菜单,先点添加当前文档,然后点开始学习** +添加文档后,插件会进行分段操作。 + +如果文档比较大,如图中的文档,百万字,插件分段起来会比较久,请耐心等待。 + +插件的分段操作不会修改原文也不会新建其他文档,只是读取、统计、建立索引。 + ![Alt text](assets/addDoc.png) ## 开始学习 +![Alt text](assets/reading.png) + +* `等号线`:等号线下面是笔记区,可以保留。等号线上面是原文,带有插件写入的备注,不要修改。 +* `当前第0段`:分片从0开始计数,0表示一本书的开头。 +* `删除,继续`:当前段的笔记不保留。 +* `制卡,继续`:当前段的笔记保留,并且把当前文档制造为闪卡,最后将删除原文和加入原文链接。 + +## 后续 +等我先用用再改…… # BUG反馈、建议 diff --git a/assets/reading.png b/assets/reading.png new file mode 100644 index 0000000..b9c98f2 Binary files /dev/null and b/assets/reading.png differ