From e0f06889cf9f23bde4e9f53776cfcd3591fb67f1 Mon Sep 17 00:00:00 2001
From: Guangzong Chen <guangzong@pitt.edu>
Date: Sun, 26 Sep 2021 16:36:48 -0400
Subject: [PATCH] update readme

---
 README.md | 90 ++++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 89 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 13a6eb0..fd07a2c 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,89 @@
-Serial Port tool
+# Serial Port tool
+
+This is a serial tool for Linux and windows.
+
+## Motivation
+
+I am a embedded sorfware developer. Usart is a very common communication protocal which used for debug.
+I was using `Moserial Terminal` and `cutecom`.  But I found serveral problem when I was using these tools.
+So I write this tool to help embedded software developer. This tool may not have all function you need, it only design for personal use.
+It will contain all function I need. If you requst some function and I think it is useful I will add it to TODO list.
+
+
+## Usage
+
+1. Only 1 input window. All function are provide by input command.
+
+Following command are support now.
+
+### set commnad 
+
+Command `set` used for setup port configuration
+
+```
+set baudrate 115200
+set databit 8
+set parity 0 // None
+set stopbit 1 
+```
+
+### open command
+
+Command `open` used for open serialport
+
+For Linux system, the port looks like `/dev/ttyUSB0`. We don't need type `/dev/tty`
+
+Example for Linux System
+
+```
+open USB0
+```
+
+Example for Windows System
+
+```
+open COM0
+```
+
+### close command
+
+command `close` used for close an opened serial port.
+
+### list command
+
+Command `list` used for list all avaliable port
+
+### send command
+
+Command `send` used for send message to port
+```
+send hello world  // "hello world" will send to port
+```
+
+### clean command
+
+Command `clean` used for clean ReceiveView and LogView
+
+```
+clean log
+clean rec
+```
+
+
+## feature list
+
+port function
+
+[*] open port
+[*] close port
+[*] send ascii to port
+[ ] send hex to port
+[ ] save output to port
+[ ] view recived data as hex
+
+
+ui function
+
+[ ] show recived data as hex
+[ ] clean command
+[ ]
\ No newline at end of file