Skip to content

Commit

Permalink
规范readme.md格式
Browse files Browse the repository at this point in the history
  • Loading branch information
jimmy-sketch committed Nov 2, 2024
1 parent efd3340 commit 8bf94c0
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
# 开源的命令行图形化库

![sandbox.gif](sandbox.gif)

本代码库旨在让开发者能够以一种简单的方式来在它们的命令行界面上放置一些简单控件,并摆脱对用Windows API等系统调用的依赖,以得到良好的跨平台效果
目前,计划有以下功能:

- [X] 支持UTF-8文本
- [X] 支持用ANSI转义序列的彩色文本
- [X] 单行文本的显示,更新
Expand All @@ -17,14 +19,17 @@
欢迎PR、star、发起issue!

## 编译方式

本项目使用cmake管理
需要使用的命令:

```
cmake -B build
```

## API 介绍
```mermaid

```mermaid
graph LR
subgraph utils
direction LR
Expand Down Expand Up @@ -60,4 +65,5 @@ graph LR
components --> page
```

更详细的介绍可以去看一看`sandbox/demo.cpp`,里面对于每种功能几乎都有测试,风格应该也还算简单易懂

0 comments on commit 8bf94c0

Please sign in to comment.