Skip to content

Commit 2560dba

Browse files
committed
Add new demo GIFs to readme, and a few minor misc tweaks
1 parent cdad78c commit 2560dba

1 file changed

Lines changed: 13 additions & 9 deletions

File tree

README.md

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,28 +3,32 @@
33
A Python implementation of virtual serial ports. Useful for developing and
44
testing programs which need to talk to a serial port.
55

6-
[![Demo](https://github.com/ezramorris/PyVirtualSerialPorts/blob/main/demo.gif)](https://github.com/ezramorris/PyVirtualSerialPorts/blob/main/demo.gif)
6+
You can:
77

8-
Example uses:
8+
* Create a virtual port which echoes back any data sent to it:
9+
[![Demo showing characters being entered into a terminal emulator being echoed back](https://github.com/ezramorris/PyVirtualSerialPorts/blob/main/images/demo_1_loopback.gif?raw=true)](https://github.com/ezramorris/PyVirtualSerialPorts/blob/main/images/demo_1_loopback.gif?raw=true)
910

10-
* Create a virtual port which echoes back any data sent to it.
11-
* Create a two or more ports; sending data to one sends data to the others.
11+
* Create a two or more ports; sending data to one sends data to the others:
12+
[![Demo showing characters being sent alternately into two terminal emulators, with the characters appearing on the opposite terminal.](https://github.com/ezramorris/PyVirtualSerialPorts/blob/main/images/demo_2.gif?raw=true)](https://github.com/ezramorris/PyVirtualSerialPorts/blob/main/images/demo_2.gif?raw=true)
1213

13-
Should work on Python 3.5+, however is only tested on supported
14+
* Monitor what is being sent between the ports:
15+
[![Demo showing characters being sent alternately in two terminal emulators, with the characters appearing on both terminals, and debug data showing in the pyvirtualserialports output.](https://github.com/ezramorris/PyVirtualSerialPorts/blob/main/images/demo_2_loopback_debug.gif?raw=true)](https://github.com/ezramorris/PyVirtualSerialPorts/blob/main/images/demo_2_loopback_debug.gif?raw=true)
16+
17+
It should work on Python 3.5+, however is only tested on supported
1418
[Python versions].
1519

1620
Has no dependencies other than the Python standard library.
1721

1822
Currently works on *nix type systems. Tested on Ubuntu and MacOS, but should
19-
work on others (BSD, etc.). Windows support is being worked on.
23+
work on others e.g. BSD. Windows support is being worked on.
2024

2125
## Installation
2226

23-
### Current user
27+
### Install for current user
2428

2529
$ pip3 install PyVirtualSerialPorts
2630

27-
### System-wide
31+
### Install system-wide
2832

2933
$ sudo pip3 install PyVirtualSerialPorts
3034

@@ -99,7 +103,7 @@ with VirtualSerialPorts(2) as ports:
99103
```
100104

101105
`ports` is a list of strings, which can be used to open the ports, e.g with
102-
PySerial. A complete example is in example.py.
106+
PySerial. A complete example is in [example.py](example.py).
103107

104108
It can also be used without a context manager as follows:
105109

0 commit comments

Comments
 (0)