Skip to content

Commit ce63816

Browse files
committed
Readme update with image and characteristics.
1 parent 0ea45b9 commit ce63816

3 files changed

Lines changed: 24 additions & 8 deletions

File tree

README.md

Lines changed: 24 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,41 @@
11
# SUSTerm
2-
A Simple Universal Serial Terminal developed using QT5.
2+
![SUSTerm GUI](https://github.com/J-Rios/SUSTerm/raw/master/SUSTerm/res/SUSTerm_GUI.png)
3+
A Simple Universal Serial Terminal) is a free and open GNU-GPL Serial Terminal developed using QT5 which is focused in be minimalist and efficiently fast and easy to use.
4+
5+
Characteristics:
6+
* Minimalist, robust, simple and fast to use.
7+
* Friendly UI similar to Arduino Serial Monitor.
8+
* Realtime Serial Ports recognized.
9+
* Close a port and connect to other without exit the app.
10+
* Bauds and End-Of-Line selectors.
11+
* Sent commands history, navigate and recover previous sent commands with arrow keys.
12+
* Can show Timestamp of received data (on each \n).
13+
* Can show received data in ASCII, HEX or Both format at same time.
14+
* Open Source and Free.
315

416
#### Install Instructions:
517
Windows:
6-
* Download [last version](https://github.com/J-Rios/SUSTerm/releases/download/v1.1/Windows_SUSTerm_v110.zip).
18+
* Download [last version](https://github.com/J-Rios/SUSTerm/releases/download/v1.2/Windows_SUSTerm_v120.zip).
719
* Unzip it and place in C:\Program File (x86)
820
* Create a desktop shortcut of C:\Program File (x86)\SUSTerm\SUSTerm.exe
921

1022
Linux:
1123
* Download last version:
1224
```
1325
$ cd ~
14-
$ wget https://github.com/J-Rios/SUSTerm/releases/download/v1.1/Linux_SUSTerm_v110.zip
26+
$ wget https://github.com/J-Rios/SUSTerm/releases/download/v1.2/Linux_SUSTerm_v120.zip
1527
```
1628

1729
* Unzip it, give execution permission and place it to user binaries apps dir:
1830
```
19-
$ unzip Linux_SUSTerm_v110.zip
20-
$ sudo chmod +x Linux_SUSTerm_v110/SUSTerm
21-
$ sudo cp -a Linux_SUSTerm_v110/SUSTerm /usr/bin/
31+
$ unzip Linux_SUSTerm_v120.zip
32+
$ sudo chmod +x Linux_SUSTerm_v120/SUSTerm
33+
$ sudo cp -a Linux_SUSTerm_v120/SUSTerm /usr/bin/
2234
```
2335

2436
* Remove unnecessary used files:
2537
```
26-
$ rm -rf Linux_SUSTerm_v110*
38+
$ rm -rf Linux_SUSTerm_v120*
2739
```
2840

2941
* Add actual user to dialout group to allow open serial ports without been root and reboot system to apply:
@@ -38,7 +50,11 @@ Linux:
3850
```
3951

4052
#### Notes:
41-
4253
- QT version is 5.11.2.
4354
- The project was written in QtCreator 4.7.1.
4455
- The implementation uses QSerialPort class to manage Serial ports.
56+
57+
#### Donate:
58+
Do you like this software? Buy me a coffee:
59+
Paypal - [https://www.paypal.me/josrios](https://www.paypal.me/josrios)
60+
BTC - 3N9wf3FunR6YNXonquBeWammaBZVzTXTyR

SUSTerm/res/SUSTerm_GUI.png

30 KB
Loading

0 commit comments

Comments
 (0)