libchai 0.2.2 → 0.2.3

package/README.md

@@ -1,55 +1,43 @@
-# chai: 汉字自动拆分系统［命令行版］
+# libchai 汉字编码输入方案优化算法
 
-`chai` 是一个使用 Rust 编写的命令行程序。用户提供拆分表以及方案配置文件，本程序能够生成编码并评测一系列指标，以及基于退火算法优化元素的布局。
+`libchai` 是使用 Rust 实现的汉字编码输入方案的优化算法。它同时发布为一个 Rust crate 和一个 NPM 模块，前者可以在 Rust 项目中安装为依赖来使用，后者可以通过汉字自动拆分系统的图形界面来使用。
 
-## 使用
+`chai` 是使用 `libchai` 实现的命令行程序，用户提供方案的配置文件、词信息文件等，本程序能够生成编码并评测一系列指标，以及基于退火算法优化元素的布局。
 
-压缩包解压后，根目录中有几个不同的二进制文件：
+## 使用 `chai`
 
-- `chai` 是 macOS 系统上的可执行文件，它是一个通用二进制文件，意味着 x86_64 架构和 arm64 架构的 Mac 电脑都能使用；
-- `chai.exe` 是 Windows 系统上的可执行文件（基于 MinGW）；
-- `chai-musl` 和 `chai-gnu` 是 Linux 系统上的可执行文件，分别基于 musl libc 和 glibc
-  - 使用 musl libc 的二进制通常兼容性较好
-  - 使用 glibc 的二进制要依赖于运行环境中的 glibc，但是通常运行效率较高
+在[发布页面](https://github.com/hanzi-chai/libchai/releases)根据您的操作系统下载相应的压缩包，支持 Windows, macOS, Linux (GNU), Linux (musl) 等多种不同的环境。压缩包中有以下的示例文件：
 
-请根据您的运行环境选用适当的二进制文件。
+- `examples/米十五笔.yaml`: 配置文件示例，具体的格式解释参见 [config.yaml 详解](https://docs.chaifen.app/docs/tutorial/config)；这个文件也可以由[汉字自动拆分系统](https://chaifen.app/)生成；
+- `examples/米十五笔.txt`: 词信息文件示例，每个字一行，每行的内容依次为汉字、空格分隔的汉字拆分序列；这个文件也可由自动拆分系统生成；
+- `assets/key_distribution.txt`：用指分布文件示例，每个按键一行，每行的内容为以制表符分隔的按键、目标频率、低频率惩罚系数、高频率惩罚系数；
+- `assets/pair_equivalence.txt`：双键速度当量文件示例，每个按键组合一行，每行的内容为以制表符分隔的按键组合和当量；
 
-### 输入格式解释及示例
+命令行程序基本的用法为：
 
-压缩包中有以下的示例文件：
-
-- `config.yaml`: 方案文件（米十五笔），具体的格式解释参见 [config.md](https://github.com/hanzi-chai/docs/blob/main/docs/tutorial/config.md)；这个文件也可以由[汉字自动拆分系统](https://chaifen.app/)生成；
-- `elements.txt`: 拆分表文件（米十五笔），每个字一行，每行的内容依次为汉字、制表符和以空格分隔的汉字拆分序列；这个文件也可由自动拆分系统生成；
-- `assets/frequency.txt`：词频文件，每个字一行，每行的内容为以制表符分隔的词和词频；
-- `assets/key_distribution.txt`：用指分布文件，每个按键一行，每行的内容为以制表符分隔的按键、目标频率、低频率惩罚系数、高频率惩罚系数；
-- `assets/pair_equivalence.txt`：双键速度当量文件，每个按键组合一行，每行的内容为以制表符分隔的按键组合和当量；
+```bash
+./chai [方案文件] -e [词信息文件] [命令]
+```
 
-可执行文件支持三个不同的命令：`encode`, `evaluate` 和 `optimize`，例如
+`chai` 支持两个不同的命令：`encode` 和 `optimize`：
 
-- `encode`：将使用方案文件和拆分表计算出字词编码
-- `evaluate`：统计各类评测指标
-- `optimize`：将基于拆分表和方案文件中的配置优化元素布局
+- `encode`：使用方案文件和拆分表计算出字词编码并统计各类评测指标
+- `optimize`：基于拆分表和方案文件中的配置优化元素布局
 
-另外，如果方案文件和拆分表文件的路径不为以上的默认值，可以通过命令行参数提供，例如
+例如，您可以运行
 
 ```bash
-./chai yima.yaml -e yima.txt optimize
+./chai examples/米十五笔.yaml -e examples/米十五笔.txt encode
 ```
 
 完整的使用说明可用 `./chai --help` 查看。
 
-## 开发
-
-需要首先运行 `make assets` 下载相关数据资源。然后 `cargo run` 即可编译运行。
-
-## 构建和部署
+## 使用 `libchai`
 
-在任何平台上只需要 `make build` 或者 `cargo build` 即可编译。
+若命令行程序的功能不能满足您的要求，您可以通过编程的方式直接使用 `libchai`。首先在本地配置好 Rust 环境，然后将 `libchai` 安装为依赖。您可以参照 [`libchai-smdc`](https://github.com/hanzi-chai/libchai-smdc) 项目来进一步了解如何通过二次开发来实现个性化的编码、评测、优化逻辑。
 
-在 `.cargo/config` 中有一个 `target.x86_64-pc-windows-gnu` 目标，是给 macOS 交叉编译 Windows 可执行文件用的，如果不做交叉编译或者不是为 Windows 平台编译的话可以忽略。
-
-`make package` 命令在 macOS 上运行的时候可以同时编译当前平台（x86_64 或 arm64）以及 Windows 的可执行文件，并打包为一个 zip 压缩文件，便于发布。
+## 开发
 
-## 性能测试
+需要首先运行 `fetch` 脚本下载相关数据资源。然后 `cargo run` 即可编译运行。
 
-需要首先运行 `make examples` 下载相关数据资源。然后 `cargo bench` 即可编译运行。
+您也可以运行 `cargo bench` 来运行性能测试。

package/chai.js

@@ -495,6 +495,14 @@ function __wbg_get_imports() {
         const ret = getObject(arg0).node;
         return addHeapObject(ret);
     };
+    imports.wbg.__wbg_now_2c95c9de01293173 = function(arg0) {
+        const ret = getObject(arg0).now();
+        return ret;
+    };
+    imports.wbg.__wbg_performance_7a3ffd0b17f663ad = function(arg0) {
+        const ret = getObject(arg0).performance;
+        return addHeapObject(ret);
+    };
     imports.wbg.__wbg_process_5c1d670bc53614b8 = function(arg0) {
         const ret = getObject(arg0).process;
         return addHeapObject(ret);

package/package.json

@@ -5,7 +5,7 @@
     "Songchen Tan <i@tansongchen.com>"
   ],
   "description": "汉字编码优化算法",
-  "version": "0.2.2",
+  "version": "0.2.3",
   "license": "GPL-3.0",
   "repository": {
     "type": "git",