FSRS4Anki 项目使用教程

FSRS4Anki 项目使用教程

fsrs4anki A modern Anki custom scheduling based on Free Spaced Repetition Scheduler algorithm 项目地址: https://gitcode.com/gh_mirrors/fs/fsrs4anki

1. 项目目录结构及介绍

FSRS4Anki 项目的目录结构如下：

fsrs4anki/
├── archive/
├── docs/
├── fsrs4anki_optimizer.ipynb
├── fsrs4anki_scheduler.js
├── fsrs4anki_scheduler_qt5.js
├── fsrs4anki_simulator.ipynb
├── .gitignore
├── CITATION.cff
├── LICENSE
├── README.md
└── all-contributorsrc

目录结构介绍

• archive/: 存放项目的归档文件。
• docs/: 存放项目的文档文件。
• fsrs4anki_optimizer.ipynb: 优化器的 Jupyter Notebook 文件，用于学习用户的记忆模式并找到最适合的参数。
• fsrs4anki_scheduler.js: 调度器的 JavaScript 文件，用于替换 Anki 的内置调度器，并根据 FSRS 算法调度卡片。
• fsrs4anki_scheduler_qt5.js: 适用于 Anki 的 Qt5 版本的调度器 JavaScript 文件。
• fsrs4anki_simulator.ipynb: 模拟器的 Jupyter Notebook 文件，用于模拟 FSRS 算法的效果。
• .gitignore: Git 忽略文件，指定哪些文件和目录不需要被 Git 跟踪。
• CITATION.cff: 引用文件，用于指定如何引用该项目。
• LICENSE: 项目的开源许可证文件，采用 MIT 许可证。
• README.md: 项目的介绍文件，包含项目的概述、使用方法和贡献指南。
• all-contributorsrc: 贡献者配置文件，用于记录项目的贡献者。

2. 项目启动文件介绍

项目的启动文件主要是 fsrs4anki_scheduler.js 和 fsrs4anki_scheduler_qt5.js。这两个文件是 FSRS4Anki 的核心组件，负责替换 Anki 的内置调度器，并根据 FSRS 算法调度卡片。

fsrs4anki_scheduler.js

• 功能: 该文件是 FSRS4Anki 的主要调度器，用于根据 FSRS 算法调度 Anki 中的卡片。
• 使用方法: 用户需要将该文件集成到 Anki 中，并配置 Anki 以使用 FSRS4Anki 调度器。

fsrs4anki_scheduler_qt5.js

• 功能: 该文件是适用于 Anki 的 Qt5 版本的调度器，功能与 fsrs4anki_scheduler.js 类似，但针对不同的 Anki 版本进行了优化。
• 使用方法: 如果用户使用的是 Anki 的 Qt5 版本，则需要使用该文件作为调度器。

3. 项目的配置文件介绍

项目的配置文件主要包括 all-contributorsrc 和 CITATION.cff。

all-contributorsrc

• 功能: 该文件用于记录项目的贡献者，包括他们的贡献类型和贡献内容。
• 使用方法: 项目维护者可以通过该文件管理和更新项目的贡献者列表。

CITATION.cff

• 功能: 该文件用于指定如何引用该项目，包括项目的作者、版本和 DOI 等信息。
• 使用方法: 用户在引用该项目时，可以参考该文件中的信息进行引用。

通过以上介绍，用户可以更好地理解 FSRS4Anki 项目的结构、启动文件和配置文件，从而更有效地使用该项目。

fsrs4anki A modern Anki custom scheduling based on Free Spaced Repetition Scheduler algorithm 项目地址: https://gitcode.com/gh_mirrors/fs/fsrs4anki