Skip to content

Commit 5c7fce8

Browse files
committed
Update Docs
1 parent 0d0144b commit 5c7fce8

3 files changed

Lines changed: 49 additions & 5 deletions

File tree

DEPLOY.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -141,6 +141,39 @@ let Result = Abra.Output() //获取输出
141141

142142
调用 `Output()` 将获得此前输入的处理结果,其返回类型可能是 `String``Uint8Array`,取决于对象实例化时指定了何种输出模式。
143143

144+
### 自行编译
145+
146+
如果你想要自行编译JavaScript库文件,请克隆 main 分支到本地。
147+
安装 `npm` 并配置恰当的环境。
148+
149+
安装编译和调试依赖:
150+
151+
```shell
152+
npm install
153+
```
154+
155+
然后执行编译指令:
156+
157+
```shell
158+
npm run build
159+
```
160+
161+
如果你对密码映射表做出了修改,那么请确保将JSON压缩成一行,转义成字符串。
162+
然后修改 `utils.js`(传统加密) 或者 `utils_next.js`(文言加密):
163+
164+
```javascript
165+
166+
const Map = '....' // 字符串内填密码映射表
167+
168+
```
169+
170+
在执行编译时,会自动对文言文密本中的句式语法执行检查,如果有问题,则会报错并提示编译失败。
171+
如果你想要单独运行检查,可以执行:
172+
173+
```shell
174+
npm run test
175+
```
176+
144177
## WebAssembly
145178

146179
前往 Release 下载编译好的 WebAssembly 文件。

README.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -51,17 +51,16 @@
5151
- 安全,AES256 + 三重转轮混淆。
5252
- 双模式,同时支持仿真加密和传统加密。
5353

54-
### **古文仿真:下一代加密方案**
54+
### **古文仿真:崭新的加密方案**
5555

5656
> 定雪以关雨,故选速文者,当事浩鹏之纯茶。作必与其雀,而航欲任以铃者,楼也。但欲极者遥,雪无文,无以致花。
5757
>
5858
> 莺在悦岩,遥城之近,游于璃。乐林曰,是故无极无畅,无纯无静,叶之所走、心之所停也。信俊灯,光善韵银,乃稍旅。秀兰能长雨之怡,行光中之迷,鹤定而瑞裳事也。文欲取庭弹度,却琴心益求,非叶也。
5959
60-
生成高仿真文言文,**参考康熙二十三年《古文观止》真实语料**
60+
生成高仿真文言文,**句式参考《古文观止》《经史百家杂钞》《古文辞类纂》等古代典籍。**
61+
不变的高强度加密,使用更复杂的组句/语法选择机制,将密码学与中国古典语言学相融合。
6162

62-
与传统方案一致的高强度加密,更复杂的组句/语法选择机制,中西合璧的设计。
63-
64-
密文高度随机,支持用户自行选择密文的随机性。
63+
密文高度随机,支持用户自定义随机性和文本风格偏好,打造前所未有的跨文化数字加密方案。
6564

6665
## 快速使用
6766

src/javascript/mapping_next.test.js

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,15 @@
1+
/*
2+
* Copyright (C) 2025 SheepChef (a.k.a. Haruka Hokuto)
3+
*
4+
* 这是一个自由软件。
5+
* 在遵守AIPL-1.1许可证的前提下,
6+
* 你可以自由复制,修改,分发,使用它。
7+
*
8+
* 查阅 Academic Innovation Protection License(AIPL) 来了解更多 .
9+
* 本作品应随附一份完整的 AIPL-1.1 许可证全文。
10+
*
11+
*/
12+
113
import { expect, test } from "vitest";
214

315
import { Map } from "./utils_next.js";

0 commit comments

Comments
 (0)