init

README.md

@@ -0,0 +1,31 @@
+# DynaNote - 简单系统
+
+## 命令列表
+
+- `list [all|整数]` - 列出记忆单元
+  - `list all` - 显示所有单元
+  - `list 5` - 显示今天需要复习≤5次的单元
+  - `list` - 等同于 `list 5`
+
+- `select <id|前缀|名称>` - 选择记忆单元
+- `attach <字符串>` - 为选中的单元附加字符串
+- `new <名称>` - 创建新记忆单元
+- `del <id|前缀|名称>` - 删除记忆单元
+- `mark <评分>` - 使用评分(0-5)更新SM-2算法
+- `show` - 显示选中单元的详细信息
+- `edit` - 使用nano编辑器编辑选中单元
+- `clear` - 清屏
+- `help` - 显示帮助和SM-2评分标准
+- `exit` - 退出shell
+
+## 数据结构
+
+记忆单元以以下结构存储在`data.toml`中：
+
+```toml
+[unit_id]
+name = "单元名称"
+attachments = [["附件文本", 时间戳]]
+created_time = 日期戳
+algodata = {"SM-2" = {"efactor" = 2.5, "real_rept" = 0, ...}}
+```