docs: 更新文档
This commit is contained in:
@@ -2,6 +2,11 @@
|
|||||||
|
|
||||||
欢迎为此项目做出贡献!
|
欢迎为此项目做出贡献!
|
||||||
|
|
||||||
|
> [!NOTE]
|
||||||
|
> 我们已经开始着手于基于 KDE 用户界面框架 `Kirigami` 的现代跨平台前端开发, 称作 "KiriMemo", 包名是 "org.kde.kirimemo", 但其并非 KDE 项目
|
||||||
|
> 它通过 `PyOtherSide` 直接复用 python 内核, 为 Windows, Linux, macOS, Android 和 Plasma Mobile 提供现代用户界面
|
||||||
|
> 如果您善于开发 C++, QML, Qt 与 KDE 框架, 欢迎加入到 KiriMemo 项目的开发
|
||||||
|
|
||||||
## 开发规范
|
## 开发规范
|
||||||
|
|
||||||
分支划分:
|
分支划分:
|
||||||
@@ -93,7 +98,7 @@ HeurAMS 被设计为一个可独立于前端的程序库, 这意味着:
|
|||||||
|
|
||||||
- 我们的内置 Textual TUI 前端不是唯一可用的前端
|
- 我们的内置 Textual TUI 前端不是唯一可用的前端
|
||||||
|
|
||||||
- 您可以在自己的项目中以独立进程/服务调用 HeurAMS (但不能在代码中链接), 而免于受 AGPL-3.0 "污染". 为了这点, 我们正在完善可选择启用的跨进程 RPC 模块, 这将成为潜进内核的跨平台标准件.
|
- 您可以在自己的项目中以独立进程/服务调用 HeurAMS, 而免于受 AGPL-3.0 "污染". 为了这点, 我们正在完善可选择启用的跨进程 RPC 模块, 这将成为潜进内核的跨平台标准件.
|
||||||
|
|
||||||
- 如果您有一个自己开发的且可用的 HeurAMS 前端 (例如我们暂未实现的 flutter 前端), 并且以 AGPL-3.0/GPL-3.0 开放源代码, 可以联系我们将它转移到 HeurAMS 的官方仓库中以便共同维护, 您将保留您的版权并可主导该仓库下的开发工作 :)
|
- 如果您有一个自己开发的且可用的 HeurAMS 前端 (例如我们暂未实现的 flutter 前端), 并且以 AGPL-3.0/GPL-3.0 开放源代码, 可以联系我们将它转移到 HeurAMS 的官方仓库中以便共同维护, 您将保留您的版权并可主导该仓库下的开发工作 :)
|
||||||
|
|
||||||
|
|||||||
15
README.md
15
README.md
@@ -7,10 +7,15 @@
|
|||||||
|
|
||||||
## 项目结构
|
## 项目结构
|
||||||
|
|
||||||
这个仓库是 "潜进" 的核心程序库在 python 语言下的实现\
|
这个仓库是 "潜进" 的核心程序库在 python 语言下的实现
|
||||||
包含数据模型与框架, 并内置了基于 textual 框架的前端实现 (interface 子模块)\
|
包含数据模型与框架, 并内置了基于 textual 框架的前端实现 (interface 子模块)
|
||||||
除了通过内置前端进行学习外, 开发者也能在 python 环境中导入 `heurams` 库或使用 `RPC` 与 `heurams` 程序库实例通讯, 使用框架构建其他辅助记忆功能前端或其他应用程序
|
除了通过内置前端进行学习外, 开发者也能在 python 环境中导入 `heurams` 库或使用 `RPC` 与 `heurams` 程序库实例通讯, 使用框架构建其他辅助记忆功能前端或其他应用程序
|
||||||
|
|
||||||
|
> [!NOTE]
|
||||||
|
> 我们已经开始着手于基于 KDE 用户界面框架 `Kirigami` 的现代跨平台应用程序前端开发, 称作 "潜进K型 (HeurAMS-K)"
|
||||||
|
> 它通过 `PyOtherSide` 直接复用 python 内核, 现代化的 UI 支持 Windows, Linux, macOS, Android 和 Plasma Mobile
|
||||||
|
> 如果您善于开发 C++, QML, Qt 与 KDE 框架, 欢迎加入到 HeurAMS-K 项目的开发
|
||||||
|
|
||||||
## 特性
|
## 特性
|
||||||
|
|
||||||
### 间隔重复调度器
|
### 间隔重复调度器
|
||||||
@@ -53,9 +58,9 @@
|
|||||||
潜进(heurams) 处于早期开发考虑, 尚未上架 PyPI, 但您可以用我们的基础设施安装稳定版和开发版本.
|
潜进(heurams) 处于早期开发考虑, 尚未上架 PyPI, 但您可以用我们的基础设施安装稳定版和开发版本.
|
||||||
|
|
||||||
> [!CAUTION]
|
> [!CAUTION]
|
||||||
> 对于部分 Linux 发行版和 Android Termux 用户:\
|
> 对于部分 Linux 发行版和 Android Termux 用户:
|
||||||
> 您需要先行安装 `cmake` 和 `libzmq` 才能正确安装项目的 `zmq` 依赖\
|
> 您需要先行安装 `cmake` 和 `libzmq` 才能正确安装项目的 `zmq` 依赖
|
||||||
> 例如在 termux 上先运行 `pkg install cmake clang libzmq`\
|
> 例如在 termux 上先运行 `pkg install cmake clang libzmq`
|
||||||
> 项目功能本身不依赖它, 但需要该依赖用于启动可选的调试服务器
|
> 项目功能本身不依赖它, 但需要该依赖用于启动可选的调试服务器
|
||||||
|
|
||||||
#### 稳定版本
|
#### 稳定版本
|
||||||
|
|||||||
Reference in New Issue
Block a user