Compare commits
1 Commits
dev
...
1d6b049a39
| Author | SHA1 | Date | |
|---|---|---|---|
| 1d6b049a39 |
@@ -2,9 +2,9 @@
|
||||
|
||||
欢迎支持此项目!
|
||||
|
||||
目前, 项目仓库主服务器为<a href="https://git.pluv27.top/pluv/HeurAMS" target="_blank" rel="noopener noreferrer">作者的 Gitea 实例</a>, 它负责管理同步, 保证可用性并同时接受来自多个社区的协作, 并在 <a href="https://github.com/pluvium27/HeurAMS" target="_blank" rel="noopener noreferrer">GitHub</a>, <a href="https://invent.kde.org/pluv/HeurAMS" target="_blank" rel="noopener noreferrer">KDE Invent</a> 和 <a href="https://gitee.com/pluv/HeurAMS" target="_blank" rel="noopener noreferrer">Gitee</a> 设置了镜像同步.
|
||||
目前, 项目仓库主服务器为<a href="https://git.pluv27.top/pluv/HeurAMS" target="_blank" rel="noopener noreferrer">作者的 Gitea 实例</a>, 以保证可用性并同时接受来自多个社区的协作, 并在 <a href="https://github.com/pluvium27/HeurAMS" target="_blank" rel="noopener noreferrer">GitHub</a> 和 <a href="https://invent.kde.org/pluv/HeurAMS" target="_blank" rel="noopener noreferrer">KDE Invent</a> 设置了镜像同步.
|
||||
|
||||
这丝毫不影响项目接受来自 <a href="https://github.com/pluvium27/HeurAMS" target="_blank" rel="noopener noreferrer">GitHub</a>, <a href="https://invent.kde.org/pluv/HeurAMS" target="_blank" rel="noopener noreferrer">KDE Invent</a> 和 <a href="https://gitee.com/pluv/HeurAMS" target="_blank" rel="noopener noreferrer">Gitee</a> 的 PR, 在 GitHub, KDE Invent 和 Gitee 所接受的 PR 会保留贡献者标识并按原样同步回所有平台, 欢迎在任意平台为项目做出贡献.
|
||||
这丝毫不影响项目接受来自 <a href="https://github.com/pluvium27/HeurAMS" target="_blank" rel="noopener noreferrer">GitHub</a> 和 <a href="https://invent.kde.org/pluv/HeurAMS" target="_blank" rel="noopener noreferrer">KDE Invent</a> 的 PR, 在 GitHub 与 KDE Invent 所接受的 PR 会保留贡献者标识并按原样同步回所有平台, 欢迎在任意平台为项目做出贡献.
|
||||
|
||||
> [!NOTE]
|
||||
> 我们已经开始着手于基于 KDE 用户界面框架 `Kirigami` 的现代跨平台前端开发, 称作 "KiriMemo", 包名是 "org.kde.kirimemo", 但其并非 KDE 项目\
|
||||
@@ -15,10 +15,10 @@
|
||||
|
||||
分支划分:
|
||||
|
||||
- `dev` 分支(仓库默认分支): 主线开发分支, 自身仅用于非重构的问题修复和整合功能分支, 拉取请求在该分支合并
|
||||
- `master` 分支: 主线稳定版本, 仅当稳定版本释出或修补版本时将 `dev` 合并到 `master` 上
|
||||
- 功能与重构分支: 从 `dev` 分支创建, 命名格式为 `feature/描述` 或 `fix/描述` 或 `refactor/描述` 或 `next/版本号`
|
||||
- 功能与重构分支应先合并至 `dev`, 再合并至 `master`
|
||||
- `main` 分支: 稳定版本, 仅当稳定版本释出或修补版本时将 `dev` 合并到 `main` 上
|
||||
- `dev` 分支: 主线开发版本, 自身仅用于非重构的问题修复和整合功能分支
|
||||
- 功能与重构分支: 从 `dev` 分支创建, 命名格式为 `feature/描述` 或 `fix/描述` 或 `refactor/v版本号`
|
||||
- 功能与重构分支应先合并至 `dev`, 再合并至 `main`
|
||||
|
||||
代码格式化:
|
||||
|
||||
@@ -42,7 +42,7 @@
|
||||
mdformat --number .
|
||||
```
|
||||
- 对于 Textual CSS, 可以使用 `prettier` 格式化
|
||||
- 格式化不是必需的, 可以整合入一次 `style` 提交, 但 `master` 和 `dev` 分支上的代码应尽量整洁, 以便合并时审查
|
||||
- 格式化不是必需的, 可以整合入一次 `style` 提交, 但 `main` 和 `dev` 分支上的代码应尽量整洁, 以便合并时审查
|
||||
|
||||
提交消息:
|
||||
|
||||
@@ -54,16 +54,12 @@
|
||||
- 为了一致性和可追溯性, 项目自 v0.4.0 重构后重新初始化仓库起就禁止使用 Fast-forward 合并
|
||||
- 可以设置 `git config merge.ff false`
|
||||
|
||||
提交署名方式:
|
||||
由于 KDE Invent 设施的奇怪 git hook, commit 的 Author 字段需要看起来像个真名(例如 Wang Zhiyu 不能写为 wangzhiyu, 否则 KDE Invent 的 hook 会拒绝 push),
|
||||
所以请确保您的 git 配置使用了类似正式姓名的格式 (例如 git config user.name "Li Hua", 也即中间需要空格), 不一定要真实姓名, 邮箱无要求, 也可以将单名重复使用两次 (例如 Thura Thura) 以通过检测.
|
||||
|
||||
## 设置开发环境
|
||||
|
||||
```bash
|
||||
git clone https://git.pluv27.top/pluv/HeurAMS # 默认分支为 dev, 所以不必切换分支
|
||||
|
||||
git clone https://git.pluv27.top/pluv/HeurAMS
|
||||
cd HeurAMS
|
||||
git checkout dev
|
||||
|
||||
# 如果决定使用 uv (推荐)
|
||||
|
||||
|
||||
2
FAQ.md
2
FAQ.md
@@ -33,8 +33,6 @@
|
||||
|
||||
## 黑乎乎的这个界面我怎么用?
|
||||
|
||||
首先, 如果您只是想要一个亮色模式, 可以直接按下 `d` 键或点击 "d 主题" 按钮, 这会让您的界面变得白乎乎的(
|
||||
|
||||
得益于微软几十年对用户进行的"命令行即落后"教育, 以及 `conhost.exe` 和 `cmd.exe` 的糟糕体验, 您对终端用户界面感到不适应是完全正常的.
|
||||
|
||||
但实际上, 虽然看起来像老式电脑屏幕, Textual 和终端标准其实比您想象得要现代一些.
|
||||
|
||||
34
README.md
34
README.md
@@ -2,9 +2,8 @@
|
||||
|
||||
## 概述
|
||||
|
||||
"潜进" (HeurAMS: Heuristic Auxiliary Memorizing Scheduler, 启发式记忆辅助调度器) 是一种基于启发式算法与认知科学理论的辅助记忆调度器, 旨在帮助用户更高效地进行记忆工作与学习规划,
|
||||
也是一种开放, 优雅, 易于扩展的间隔重复调度器实验平台, 旨在帮助研究者更高效地进行前沿记忆算法的研究.
|
||||
<a href="https://github.com/pluvium27/HeurAMS" target="_blank" rel="noopener noreferrer">GitHub</a> <a href="https://invent.kde.org/pluv/HeurAMS" target="_blank" rel="noopener noreferrer">KDE Invent</a> <a href="https://gitee.com/pluv/HeurAMS" target="_blank" rel="noopener noreferrer">Gitee</a> <a href="https://git.pluv27.top/pluv/HeurAMS" target="_blank" rel="noopener noreferrer">作者的 Gitea 实例</a>
|
||||
"潜进" (HeurAMS: Heuristic Auxiliary Memorizing Scheduler, 启发式记忆辅助调度器) 是一种基于启发式算法与认知科学理论的辅助记忆调度器, 旨在帮助用户更高效地进行记忆工作与学习规划,\
|
||||
也是一种开放, 优雅, 易于扩展的间隔重复调度器实验平台, 旨在帮助研究者更高效地进行前沿记忆算法的研究.
|
||||
|
||||
## 关于此仓库
|
||||
|
||||
@@ -12,17 +11,10 @@
|
||||
包含数据模型与框架, 并内置了基于 textual 框架的前端实现 (interface 子模块)\
|
||||
除了通过内置前端进行学习外, 开发者也能在 python 环境中导入 `heurams` 库或使用 `RPC` 与 `heurams` 程序库实例通讯, 使用框架构建其他辅助记忆功能前端或其他应用程序
|
||||
|
||||
潜进项目的所有仓库如下:
|
||||
|
||||
| 项目名称 | 状态 | 说明 | 包名 | 技术栈 | 目标平台 |
|
||||
| :--- | :--- | :--- | :--- | :--- | :--- |
|
||||
| HeurAMS | 开发中<br/>原型可用 | Python 核心程序库与基本用户界面 | `heurams` | Python | 跨平台 |
|
||||
| KiriMemo | 开发中<br/>原型可用 | 现代跨平台前端 | `org.kde.kirimemo` | Qt6, Kirigami, PyOtherSide | 桌面与移动设备 |
|
||||
| HeurStudio | 计划中 | AI 辅助的单体单元集高级创建与编辑工具 | `top.pluv27.heurstudio` | Qt6, Kirigami, PyOtherSide | 桌面 |
|
||||
| HeurSync | 开发中 | 用户数据同步服务器<br/>集成 Web 前端与排行榜 | `heurrepo` | Go, SQLite | 网页与服务器 |
|
||||
| HeurRepo | 计划中 | 单元集文档源服务器<br/>与单元集分享平台 | `heurrepo` | Go, SQLite | 网页与服务器 |
|
||||
|
||||
尽管现在后三样有点画大饼的意思, 但是我们的路线是明了的
|
||||
> [!NOTE]
|
||||
> 我们已经着手于基于 KDE 用户界面框架 `Kirigami` 的现代跨平台前端开发, 称作 "KiriMemo", 包名是 "org.kde.kirimemo", 但其并非 KDE 项目\
|
||||
> 它通过 `PyOtherSide` 直接复用 python 内核, 为 Windows, Linux, macOS, Android, iOS 和 Plasma Mobile 提供现代用户界面\
|
||||
> 如果您善于开发 C++, QML, Qt 与 KDE 框架, 欢迎加入到 KiriMemo 项目的开发
|
||||
|
||||
## 特性
|
||||
|
||||
@@ -70,7 +62,7 @@
|
||||
- 资源占用小, 运行流畅, 不拖泥带水
|
||||
- 便于测试与调试程序库
|
||||
|
||||
查看[屏幕截图](SCREENSHOTS.md).
|
||||
[查看屏幕截图](SCREENSHOTS.md)
|
||||
|
||||
## 快速开始
|
||||
|
||||
@@ -144,17 +136,15 @@ python -m pip install heurams[all] -i https://pypi.pluv27.top/root/dev/+simple/
|
||||
|
||||
## 项目标识
|
||||
|
||||
HeurAMS 项目标识如下, 文件(位图和矢量图)位于 `./src/heurams/assets/art/` 目录.
|
||||
HeurAMS 项目标识如下, 矢量图文件位于 `./src/heurams/assets/art/` 目录.
|
||||
|
||||
<img src="src/heurams/assets/art/banner128-light.png" height="96px" title="位图横幅(不透明)">
|
||||
<div style="display: flex; flex-wrap: wrap; gap: 5px;">
|
||||
<img src="src/heurams/assets/art/logo.svg" height="96px" title="矢量图标">
|
||||
<img src="src/heurams/assets/art/logo-mono-light.svg" height="96px" title="单色明亮矢量图标">
|
||||
<img src="src/heurams/assets/art/logo-mono-dark.svg" height="96px" title="单色暗色矢量图标">
|
||||
<img src="src/heurams/assets/art/logo.svg" height="96px">
|
||||
<img src="src/heurams/assets/art/logo-mono-light.svg" height="96px">
|
||||
<img src="src/heurams/assets/art/logo-mono-dark.svg" height="96px">
|
||||
</div>
|
||||
|
||||
颜色分别是: `#1660A5 (海蓝色)` `#545F70 (蓝灰色)` `#FFFFFF (单色明亮图标白色)` `#1A1A1A (单色暗色图标深黑色)` `#2f2f35 (文字颜色)`.
|
||||
|
||||
颜色分别是: `#1660A5 (海蓝色)` `#545F70 (蓝灰色)` `#1A1A1A (暗色单色图标深黑色)` `#FFFFFF (明亮单色图标白色)`.
|
||||
|
||||
## 许可证
|
||||
|
||||
|
||||
Reference in New Issue
Block a user