Skip to content

Commit ef30f0f

Browse files
authored
Merge pull request #39 from JensvanEsch/master
Update README.md
2 parents 78b1d63 + 1069d6d commit ef30f0f

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -57,11 +57,11 @@ Library for communicating with COM ports on a Linux system.
5757
$ make run_unit_tests
5858
```
5959

60-
NOTE: The unit tests used to use virtual serial ports via `stty` on Linux to do more through testing. I ran into permission problems running stty on TravisCI after they did an update and had to remove tests (leaving almost no tests remaining). If anyone wants to add better unit tests, it is greatly welcomed!
60+
NOTE: The unit tests used to use virtual serial ports via `stty` on Linux to do more thorough testing. I ran into permission problems running stty on TravisCI after they did an update and had to remove tests (leaving almost no tests remaining). If anyone wants to add better unit tests, it is greatly welcomed!
6161

62-
## Using This Project As A CMake Deoendency
62+
## Using This Project As A CMake Dependency
6363

64-
This project uses CMake and the export feature, so in a downstream CMake project that uses CppLinuxSerial as a dependency you should just be able to do (thanks to https://github.com/borgmanJeremy for this contribution):
64+
This project uses CMake and the export feature, so in a downstream CMake project that uses CppLinuxSerial as a dependency you should just be able to do this (thanks to https://github.com/borgmanJeremy for this contribution):
6565

6666
```cmake
6767
find_package(CppLinuxSerial REQUIRED)
@@ -78,7 +78,7 @@ target_link_libraries(target CppLinuxSerial::CppLinuxSerial)
7878
using namespace mn::CppLinuxSerial;
7979

8080
int main() {
81-
// Create serial port object and open serial port at 57600 buad, 8 data bits, no parity bit, one stop bit (8n1),
81+
// Create serial port object and open serial port at 57600 baud, 8 data bits, no parity bit, one stop bit (8n1),
8282
// and no flow control
8383
SerialPort serialPort("/dev/ttyUSB0", BaudRate::B_57600, NumDataBits::EIGHT, Parity::NONE, NumStopBits::ONE);
8484
// Use SerialPort serialPort("/dev/ttyACM0", 13000); instead if you want to provide a custom baud rate
@@ -170,7 +170,7 @@ sudo chmod 666 /dev/ttyACM0
170170

171171
Serial port testing cannot really be done easily on cloud-based CICD platforms, as serial ports and devices connected to these ports are not readibly available (nor configurable). `CppLinuxSerial` relies on running tests manually on your local Linux OS, alongside a connected Arduino Uno configured to echo serial data back (at a later data this could be reconfigured to cycle through tests at different baud rates, parity settings, e.t.c).
172172

173-
### Prerequisties
173+
### Prerequisites
174174

175175
You will need:
176176

0 commit comments

Comments
 (0)