Skip to content

Commit

Permalink
Readme update with image and characteristics.
Browse files Browse the repository at this point in the history
  • Loading branch information
J-Rios committed Nov 11, 2018
1 parent 0ea45b9 commit ce63816
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 8 deletions.
32 changes: 24 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,41 @@
# SUSTerm
A Simple Universal Serial Terminal developed using QT5.
![SUSTerm GUI](https://github.com/J-Rios/SUSTerm/raw/master/SUSTerm/res/SUSTerm_GUI.png)
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.

Characteristics:
* Minimalist, robust, simple and fast to use.
* Friendly UI similar to Arduino Serial Monitor.
* Realtime Serial Ports recognized.
* Close a port and connect to other without exit the app.
* Bauds and End-Of-Line selectors.
* Sent commands history, navigate and recover previous sent commands with arrow keys.
* Can show Timestamp of received data (on each \n).
* Can show received data in ASCII, HEX or Both format at same time.
* Open Source and Free.

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

Linux:
* Download last version:
```
$ cd ~
$ wget https://github.com/J-Rios/SUSTerm/releases/download/v1.1/Linux_SUSTerm_v110.zip
$ wget https://github.com/J-Rios/SUSTerm/releases/download/v1.2/Linux_SUSTerm_v120.zip
```

* Unzip it, give execution permission and place it to user binaries apps dir:
```
$ unzip Linux_SUSTerm_v110.zip
$ sudo chmod +x Linux_SUSTerm_v110/SUSTerm
$ sudo cp -a Linux_SUSTerm_v110/SUSTerm /usr/bin/
$ unzip Linux_SUSTerm_v120.zip
$ sudo chmod +x Linux_SUSTerm_v120/SUSTerm
$ sudo cp -a Linux_SUSTerm_v120/SUSTerm /usr/bin/
```

* Remove unnecessary used files:
```
$ rm -rf Linux_SUSTerm_v110*
$ rm -rf Linux_SUSTerm_v120*
```

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

#### Notes:

- QT version is 5.11.2.
- The project was written in QtCreator 4.7.1.
- The implementation uses QSerialPort class to manage Serial ports.

#### Donate:
Do you like this software? Buy me a coffee:
Paypal - [https://www.paypal.me/josrios](https://www.paypal.me/josrios)
BTC - 3N9wf3FunR6YNXonquBeWammaBZVzTXTyR
Binary file added SUSTerm/res/SUSTerm_GUI.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes

0 comments on commit ce63816

Please sign in to comment.