Skip to content

Commit

Permalink
Doc/add ts fsrs workflow (#96)
Browse files Browse the repository at this point in the history
  • Loading branch information
ishiko732 authored Jul 13, 2024
1 parent 8d61183 commit 173c19c
Show file tree
Hide file tree
Showing 4 changed files with 190 additions and 0 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,11 @@
ts-fsrs is a [ES modules package](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c) based on TypeScript, used to implement the [Free Spaced Repetition Scheduler (FSRS) algorithm](https://github.com/open-spaced-repetition/free-spaced-repetition-scheduler). It helps
developers apply FSRS to their flashcard applications, there by improving the user learning experience.

The workflow for TS-FSRS can be referenced from the following resources:
> - google driver: [ts-fsrs-workflow.drawio](https://drive.google.com/file/d/1FLKjpt4T3Iis02vjoA10q7vxKCWwClfR/view?usp=sharing) (You may provide commentary)
> - github: [ts-fsrs-workflow.drawio](./ts-fsrs-workflow.drawio)

# Usage
You need to run on Node.js (>=16.0.0) , using the `"type":"module"` by default in `package.json`.

Expand Down
2 changes: 2 additions & 0 deletions README_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ ts-fsrs 是一个基于TypeScript开发的[ES modules包](https://gist.github.co
,用于实现[自由间隔重复调度器(FSRS)算法](https://github.com/open-spaced-repetition/free-spaced-repetition-scheduler/blob/main/README_CN.md)
的工具。它可以帮助开发者将FSRS应用到他们的记忆卡应用中,从而提升用户的学习体验。

> 你可以通过[ts-fsrs-workflow.drawio](./ts-fsrs-workflow.drawio)来获取ts-fsrs的工作流信息。
# 使用ts-fsrs

你需要运行在 Node.js (>=16.0.0)上,并且在`package.json`默认使用 `"type":"module"`
Expand Down
5 changes: 5 additions & 0 deletions README_JP.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,11 @@ ts-fsrsは[自由間隔重複スケジューラ(FSRS)アルゴリズム](htt
を実装するための、TypeScriptで開発された[ESモジュールパッケージ](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c)
です。このツールは、開発者がFSRSアルゴリズムを彼らのフラッシュカードアプリケーションに適用し、ユーザーの学習体験を向上させるのに役立ちます。

ts-fsrsのワークフローについては、以下のリソースを参照してください。
> - google driver: [ts-fsrs-workflow.drawio](https://drive.google.com/file/d/1FLKjpt4T3Iis02vjoA10q7vxKCWwClfR/view?usp=sharing) (コメントを提供できます)
> - github: [ts-fsrs-workflow.drawio](./ts-fsrs-workflow.drawio)

# ts-fsrsの使用方法

Node.js (バージョン >= 16.0.0)を実行する環境を準備して、`package.json``"type":"module"`をデフォルトに設定してください。
Expand Down
Loading

0 comments on commit 173c19c

Please sign in to comment.