diff --git a/.github/shibako.jpg b/.github/shibako.jpg new file mode 100644 index 0000000..0da8271 Binary files /dev/null and b/.github/shibako.jpg differ diff --git a/README.md b/README.md index 46b515e..4727c31 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,10 @@ -# simple-kanban -基于C语言Socket编程的简易公告发布程序 +
+ Shinsako
+

simple-kanban

+ 基于C语言Socket编程的简易公告发布程序

+
-# 准备工作 +## 准备工作 您需要首先安装[simple-protobuf](https://github.com/fumiama/simple-protobuf),并记住安装路径。如果安装路径不是`/usr/local`,需要手动更改`CMakeLists.txt`的路径指向正确位置。 ```bash @@ -13,7 +16,7 @@ make make install ``` -# 编译 +## 编译 仅适用于类`unix`系统(包括Apple),`windows`下编译请自行将`socket`实现替换为`winsock` @@ -27,14 +30,14 @@ make make install ``` -# 数据格式 +## 数据格式 1. 看板、数据的报文头部有固定的4字节(小端序),用来标识之后数据的长度,但回复串(succ/erro/null/get/set)则无此头部。 2. PASSWORD、SETPASS位于`server.c`头部,可自行定义。 -# 服务端使用 +## 服务端使用 -## 0. 启动程序 +### 0. 启动程序 ```bash simple-kanban [-d] 7777 1 ./kanban.txt ./data.bin ./cfg.sp @@ -43,25 +46,25 @@ simple-kanban [-d] 7777 1 ./kanban.txt ./data.bin ./cfg.sp 1. -d为可选项,如果添加,程序将以daemon状态运行。 2. `cfg.sp`为配置文件,通过编译生成的`cfgwriter`生成 -## 1. 建立连接 +### 1. 建立连接 连接后10秒无下一步操作自动断开。建立连接的操作一次会话只需执行一次。 - 发送:`PASSWORD`字串 -## 2. 获得看板 +### 2. 获得看板 - 发送:get - 返回:get - 发送:版本号(一串数字) - 返回:头+看板(有新消息)/`null`(无新消息) -## 3. 获得数据 +### 3. 获得数据 - 发送:cat - 返回:头+数据 -## 4. 设置看板 +### 4. 设置看板 - 发送:`SETPASS` - 返回:`SETPASS` @@ -70,7 +73,7 @@ simple-kanban [-d] 7777 1 ./kanban.txt ./data.bin ./cfg.sp - 发送:头+新的看板 - 返回:succ -## 5. 设置数据 +### 5. 设置数据 - 发送:`SETPASS` - 返回:`SETPASS` @@ -79,11 +82,11 @@ simple-kanban [-d] 7777 1 ./kanban.txt ./data.bin ./cfg.sp - 发送:头+新的数据 - 返回:succ -# 简易客户端使用 +## 简易客户端使用 本程序自带一个简易客户端`client.c`,编译后名为`simple-kanban-client`,能够实现所有和服务端的交互功能。 -## 0. 启动程序 +### 0. 启动程序 ```bash ./simple-kanban-client 127.0.0.1 7777 @@ -91,23 +94,23 @@ simple-kanban [-d] 7777 1 ./kanban.txt ./data.bin ./cfg.sp 接下来即可按照上面的交互流程开始使用。 -## 1. 发送命令 +### 1. 发送命令 直接输入命令,回车即可。 -## 2. 发送文件 +### 2. 发送文件 键入:file 回车,然后输入文件路径,回车即可。 -## 3. 退出 +### 3. 退出 键入:quit 回车即可 -# 上传小工具 +## 上传小工具 在`uploader`文件夹有一个上传小工具,用法如下 ```bash