docs: 修改文档
This commit is contained in:
@@ -1,142 +1,143 @@
|
||||
# 潜进 (HeurAMS) - 启发式辅助记忆调度器
|
||||
# HeurAMS - Heuristic Auxiliary Memorizing Scheduler
|
||||
|
||||
## 概述
|
||||
[中文](README_zh.md) | English
|
||||
|
||||
"潜进" (HeurAMS: Heuristic Auxiliary Memorizing Scheduler, 启发式记忆辅助调度器) 是一种基于启发式算法与认知科学理论的辅助记忆调度器, 旨在帮助用户更高效地进行记忆工作与学习规划,
|
||||
也是一种开放, 优雅, 易于扩展的间隔重复调度器实验平台, 旨在帮助研究者更高效地进行前沿记忆算法的调查实验与研究.
|
||||
## Overview
|
||||
|
||||
[详细介绍](INTRODUCTION.md) [屏幕截图](SCREENSHOTS.md)
|
||||
HeurAMS "潜进" (Heuristic Auxiliary Memorizing Scheduler) is an auxiliary memorizing scheduler based on heuristic algorithms and cognitive science theories, designed to help users memorize and plan learning more efficiently.
|
||||
It is also an open, elegant, and extensible spaced repetition scheduler experiment platform, intended to help researchers conduct investigations, experiments, and research on cutting-edge memory algorithms more efficiently.
|
||||
|
||||
[Detailed Introduction](INTRODUCTION.md) | [Screenshots](SCREENSHOTS.md)
|
||||
|
||||
<p align="left">
|
||||
<a href="https://github.com/pluvium27/HeurAMS" target="_blank" rel="noopener noreferrer"><img src="https://img.shields.io/badge/GitHub-fafafa?style=for-the-badge&logo=github&logoColor=181717" alt="GitHub" /></a><a href="https://invent.kde.org/pluv/HeurAMS" target="_blank" rel="noopener noreferrer"><img src="https://img.shields.io/badge/KDE_Invent-1D99F3?style=for-the-badge&logo=kde&logoColor=white" alt="KDE Invent" /></a><a href="https://gitee.com/pluv/HeurAMS" target="_blank" rel="noopener noreferrer"><img src="https://img.shields.io/badge/Gitee-C71D23?style=for-the-badge&logo=gitee&logoColor=white" alt="Gitee" /></a><a href="https://git.pluv27.top/pluv/HeurAMS" target="_blank" rel="noopener noreferrer"><img src="https://img.shields.io/badge/git.pluv27.top-609926?style=for-the-badge&logo=gitea&logoColor=white" alt="git.pluv27.top" /></a>
|
||||
</p>
|
||||
|
||||
## 快速开始
|
||||
## Quick Start
|
||||
|
||||
### 安装软件
|
||||
### Installation
|
||||
|
||||
#### 从包管理器安装
|
||||
#### Install from Package Manager
|
||||
|
||||
潜进 (包名是 `heurams`) 处于早期开发考虑, 尚未上架 PyPI.
|
||||
但可以用 pip 从仓库安装稳定版和开发版本, 这要求设备上安装了 python 环境 (建议 3.12.13 及之后版本).
|
||||
HeurAMS (package name `heurams`) is in early development and not yet available on PyPI.
|
||||
However, you can install stable and development versions from the repository using pip, which requires a Python environment (Python 3.12.13 or later recommended).
|
||||
|
||||
从稳定的 `master` 分支安装, 并安装适用于用户体验的可选依赖(推荐):
|
||||
Install from the stable `master` branch with optional dependencies for user experience (recommended):
|
||||
|
||||
```
|
||||
pip install --upgrade 'heurams[basic] @ https://git.pluv27.top/pluv/HeurAMS/archive/master.zip'
|
||||
```
|
||||
|
||||
从较前沿, 大致稳定的 `dev` 分支安装, 并安装适用于用户体验的可选依赖(如果您追求较前沿的改进):
|
||||
Install from the more recent, roughly stable `dev` branch with optional dependencies (if you want cutting-edge improvements):
|
||||
|
||||
```
|
||||
pip install --force-reinstall --no-deps 'heurams[basic] @ https://git.pluv27.top/pluv/HeurAMS/archive/dev.zip'
|
||||
```
|
||||
|
||||
安装适用于一般计算机的通用音频模块 (基于 playsound3):\
|
||||
(此项不适用于 termux 环境, termux 的音频支持是内建的)
|
||||
Install the general audio module for desktop computers (based on playsound3):\
|
||||
(Not applicable for termux environments; termux has built-in audio support)
|
||||
|
||||
```
|
||||
pip install --upgrade 'heurams[audio-playsound] @ https://git.pluv27.top/pluv/HeurAMS/archive/master.zip'
|
||||
```
|
||||
|
||||
> 您也可以从 `refactor/...` 等特定分支安装以测试某项更改
|
||||
> You can also install from specific branches like `refactor/...` to test particular changes.
|
||||
|
||||
[依赖分组说明](INTRODUCTION.md#包依赖组说明)
|
||||
[Dependency Group Reference](INTRODUCTION.md#package-dependency-groups)
|
||||
|
||||
#### 从源码安装
|
||||
#### Install from Source
|
||||
|
||||
我们提供原生 python 和 uv 两种源码安装方式.\
|
||||
详见[贡献指南 - 设置开发环境](CONTRIBUTING.md#设置开发环境).
|
||||
We provide two source installation methods: native Python and uv.
|
||||
See the [Contributing Guide - Setting up Development Environment](CONTRIBUTING.md#setting-up-development-environment) for details.
|
||||
|
||||
### 使用软件
|
||||
### Usage
|
||||
|
||||
在终端中运行 `heurams`, 您会看到一系列帮助信息, 例如:
|
||||
Run `heurams` in your terminal, and you will see help information:
|
||||
|
||||
```plain
|
||||
~ $ heurams
|
||||
Usage: heurams [OPTIONS] COMMAND [ARGS]...
|
||||
|
||||
HeurAMS 0.5.1 - 启发式辅助记忆调度器
|
||||
HeurAMS 0.5.1 - Heuristic Auxiliary Memorizing Scheduler
|
||||
|
||||
Options:
|
||||
-v, --version Show the version and exit.
|
||||
-h, --help Show this message and exit.
|
||||
|
||||
Commands:
|
||||
help 显示此帮助信息
|
||||
tui 启动内置基本用户界面 (TUI)
|
||||
version 输出版本信息
|
||||
help Show this help message
|
||||
tui Launch the built-in basic user interface (TUI)
|
||||
version Print version information
|
||||
```
|
||||
|
||||
可以通过键入 `heurams tui` 启动基本用户界面, 例如:
|
||||
Start the basic user interface by typing `heurams tui`:
|
||||
|
||||
```plain
|
||||
~ $ heurams tui
|
||||
欢迎使用基本用户界面!
|
||||
加载配置与上下文... 已完成! (耗时: 33ms)
|
||||
加载用户界面框架... 已完成! (耗时: 169ms)
|
||||
加载用户界面布局... 已完成! (耗时: 165ms)
|
||||
组件目录: <软件包所在目录>
|
||||
工作目录: <运行目录, 将在此目录下建立 ./data 文件夹>
|
||||
前置工作共计耗时: 142ms
|
||||
Welcome to the basic user interface!
|
||||
Loading config and context... Done! (2ms)
|
||||
Loading UI framework... Done! (89ms)
|
||||
Loading UI layout... Done! (56ms)
|
||||
Component directory: <package directory>
|
||||
Working directory: <working directory, ./data folder will be created here>
|
||||
Pre-work total: 147ms
|
||||
|
||||
(此时您的终端将转为呈现美观的 TUI 基本用户界面)
|
||||
(Your terminal will now display the TUI)
|
||||
```
|
||||
|
||||
通过键入 `heurams -v` 查看版本:
|
||||
Check the version with `heurams -v`:
|
||||
|
||||
```
|
||||
~ $ heurams -v
|
||||
HeurAMS 0.5.1 stable (fulcrum/支点), Linux
|
||||
```
|
||||
|
||||
## 常见问题 (FAQ)
|
||||
## Frequently Asked Questions (FAQ)
|
||||
|
||||
详见[常见问题](FAQ.md).
|
||||
See [FAQ](FAQ.md).
|
||||
|
||||
## 项目架构
|
||||
## Project Architecture
|
||||
|
||||
详见[架构说明](ARCHITECTURE.md).
|
||||
See [Architecture Overview](ARCHITECTURE.md).
|
||||
|
||||
## 参与项目
|
||||
## Contributing
|
||||
|
||||
欢迎参与到项目协作中!\
|
||||
详见[贡献指南](CONTRIBUTING.md).\
|
||||
关于 AI 辅助开发的说明, 请参阅 [AGENTS.md](AGENTS.md).
|
||||
Contributions are welcome!
|
||||
See the [Contributing Guide](CONTRIBUTING.md).
|
||||
For AI-assisted development guidelines, see [AGENTS.md](AGENTS.md).
|
||||
|
||||
## 项目标识
|
||||
## Project Identity
|
||||
|
||||
HeurAMS 项目标识如下, 文件(位图和矢量图)位于 `./src/heurams/assets/art/` 目录.
|
||||
HeurAMS project identity assets are located in `./src/heurams/assets/art/` directory:
|
||||
|
||||
<img src="src/heurams/assets/art/banner128-light.png" height="96px" title="位图横幅(不透明)">
|
||||
<img src="src/heurams/assets/art/banner128-light.png" height="96px" title="Bitmap Banner (Opaque)">
|
||||
<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" title="Vector Icon">
|
||||
<img src="src/heurams/assets/art/logo-mono-light.svg" height="96px" title="Monochrome Light Vector Icon">
|
||||
<img src="src/heurams/assets/art/logo-mono-dark.svg" height="96px" title="Monochrome Dark Vector Icon">
|
||||
</div>
|
||||
|
||||
颜色分别是: `#1660A5 (海蓝色)` `#545F70 (蓝灰色)` `#FFFFFF (单色明亮图标白色)` `#1A1A1A (单色暗色图标深黑色)` `#2f2f35 (文字颜色)`.
|
||||
Colors: `#1660A5 (Ocean Blue)` `#545F70 (Blue Gray)` `#FFFFFF (Monochrome Light Icon White)` `#1A1A1A (Monochrome Dark Icon Deep Black)` `#2f2f35 (Text Color)`.
|
||||
|
||||
## License
|
||||
|
||||
## 许可证
|
||||
### Project
|
||||
|
||||
### 项目本身
|
||||
This project is open source under the AGPL-3.0 license, with an additional exemption clause for local API calls, making it more permissive than the standard AGPL-3.0.
|
||||
|
||||
本项目基于 AGPL-3.0 许可证开放源代码, 并有一个豁免本机 API 调用的附加条款, 较标准 AGPL-3.0 更宽松.
|
||||
See the [LICENSE](LICENSE) file in the root directory.
|
||||
|
||||
详见根目录下 [LICENSE](LICENSE) 文件.
|
||||
### Third-Party Code
|
||||
|
||||
### 第三方代码
|
||||
|
||||
项目在 `src/heurams/vendor/` 目录下嵌入或在其他位置直接使用了以下第三方代码或其衍生作品 (可能有修改):
|
||||
The project embeds or directly uses the following third-party code or its derivatives (possibly with modifications) in `src/heurams/vendor/` or other locations:
|
||||
|
||||
#### SM.js
|
||||
|
||||
- 上游版本: commit `6e3bb4a` (2015年2月4日上游已停止维护)
|
||||
- 引用方式: 将 coffeescript 重写为 python 并间接引用, 数学原理一致; 并对重写后代码进行逻辑, 性能与标准化 API 改进
|
||||
- 位置: `src/heurams/kernel/algorithms/sm15m.py`
|
||||
- 原项目: [SM.js](https://github.com/slaypni/SM-15)
|
||||
- 原版权: Copyright (c) 2014 Kazuaki Tanida
|
||||
- 原许可证: MIT License
|
||||
- Upstream version: commit `6e3bb4a` (upstream discontinued as of Feb 4, 2015)
|
||||
- Usage: Rewritten from CoffeeScript to Python with indirect reference, maintaining the same mathematical principles; improved logic, performance, and standardized API
|
||||
- Location: `src/heurams/kernel/algorithms/sm15m.py`
|
||||
- Original project: [SM.js](https://github.com/slaypni/SM-15)
|
||||
- Original copyright: Copyright (c) 2014 Kazuaki Tanida
|
||||
- Original license: MIT License
|
||||
|
||||
本项目受益于他们无私且优秀的工作.
|
||||
This project benefits from their selfless and excellent work.
|
||||
|
||||
Reference in New Issue
Block a user