Skip to content

Commit c1b8fcd

Browse files
committed
完善readme
1 parent 5dacf00 commit c1b8fcd

File tree

1 file changed

+58
-0
lines changed

1 file changed

+58
-0
lines changed

README.md

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,60 @@
11
# Held
2+
23
DragonOS/Linux Termial text editor
4+
5+
面向DragonOS和Linux系统的终端文本编辑器。
6+
7+
8+
作者:Heyicong [email protected]
9+
10+
---
11+
12+
## 安装
13+
14+
默认安装路径为``./install/bin/held``
15+
16+
- Linux: ``make install-linux``
17+
- DragonOS: ``make install-dragonos``
18+
19+
## 使用
20+
21+
**Held**的设计思路是能够使用简单命令实现高效编辑,高效跳转。
22+
23+
Held提供了三个模式:``Command````LastLine````Insert``
24+
25+
- **Command**
26+
27+
- ``:`` 进入底线(LastLine)模式
28+
- ``i`` 进入插入模式
29+
- ``f`` 标记当前行
30+
- ``l`` 锁定当前行(该行不能被改动/删除)
31+
- ``q`` 跳转到前一个标记行
32+
- ``w`` 跳转到后一个标记行
33+
- ``a`` 跳转到上一个锁定行
34+
- ``s`` 跳转到下一个锁定行
35+
- **LastLine**
36+
37+
- ``:q`` 不保存退出
38+
- ``:q!`` 强制不保存退出
39+
- ``:wq`` 保存退出
40+
- ``:goto | :gt`` 跳转到行或行列
41+
- ``:flag | :lock`` 批量标记或锁定行
42+
- ``:unflag | :unlock`` 批量取消标记或锁
43+
- ``:delete | :dl`` 批量删除行(锁定行将不被影响)
44+
45+
## 风格
46+
47+
Held支持自定义部分风格,
48+
49+
可以编辑``config.yaml``并且将其放置与Held同目录,Held将会使用你配置的风格。
50+
51+
目前支持的配置:
52+
53+
- ``line`` 整体行设置
54+
- ``number`` 行号设置
55+
- ``enable`` 是否启用
56+
- ``backgroud`` 设置行号列背景色
57+
- ``frontground`` 设置行号列前景色
58+
- ``highlight`` 当前行高亮选项
59+
- ``enable`` 是否启用
60+
- ``color`` 高亮颜色

0 commit comments

Comments
 (0)