Skip to content

Commit ba6a531

Browse files
committed
Update README
1 parent d7c8cc6 commit ba6a531

File tree

2 files changed

+31
-1
lines changed

2 files changed

+31
-1
lines changed

README.md

Lines changed: 31 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,44 @@
22

33
An open-source serial port access application for Linux and Windows written in C++ with Qt5.
44

5+
![Screenshot](screenshots/screenshot-2019-07-05.png?raw=true "5Com screenshot")
6+
57
## Features
68
- You can view the serial port output
79
- In a human-readable plain text format
810
- In hex mode
911
- In a verbose mode showing specific information for each byte
1012
- You can directly write a file to the serial port
1113
- You can send custom input to the port (with escape codes support)
12-
- You can export the data read from the port in plain text, hex or raw formats
14+
- You can export the data read from the port in plain text, hex, raw and csv formats
1315
- Support for custom baud rates (as long as the hardware also supports it)
1416
- Support for custom continuous transmission with a fixed packet interval
17+
- Support for custom sequences of data sending, waiting and RTS/DTR modifying
1518
- Option to view the pinout signals and manually change the RTS and DTR pins
19+
- A lot of other small convenience features
20+
21+
## Installing from source
22+
23+
### Compiling
24+
25+
git clone https://github.com/pgeorgiev98/5Com
26+
mkdir 5Com/build
27+
cd 5Com/build
28+
29+
# Make sure you're using the qt5 version of qmake. On some distributions
30+
# you may have to call `qmake -qt=5 ..` instead for example
31+
qmake ..
32+
33+
# You may use make -jN where N is the number of threads your CPU has.
34+
# This should greatly speed up the compilation
35+
make
36+
37+
# You can now check if the application works as normal
38+
app/5Com
39+
40+
### Installing
41+
42+
After compiling you can install it by running
43+
44+
sudo make install
45+
95.5 KB
Loading

0 commit comments

Comments
 (0)