Peter M. Groen / CppLinuxSerial

Commit 819155b9510b981b2f9b0087f6b8c2e9bac65060

Authored by Geoffrey Hunter
1 parent d9fb816b

Fixed a build error by changing the branch cmake downloads googletest from master to main.

Inline Side-by-side
Showing 3 changed files with 14 additions and 6 deletions
CHANGELOG.md
  View file @819155b
... ... @@ -5,6 +5,14 @@ All notable changes to this project will be documented in this file.
5 5 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
6 6 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
7 7  
  8 +## [v2.2.1] - 2021-12-06
  9 +
  10 +- Fixed a build error by changing the branch cmake downloads googletest from master to main.
  11 +
  12 +## [v2.2.0] - 2021-12-03
  13 +
  14 +- ReadBinary() and WriteBinary() added to read/write raw data, instead of having to use strings (thanks to @RolandHughes for adding this).
  15 +
8 16 ## [v2.1.2] - 2021-07-01
9 17  
10 18 - Removed download of gtest if tests are not built.
... ...
CMakeLists.txt.in
  View file @819155b
... ... @@ -5,7 +5,7 @@ project(googletest-download NONE)
5 5 include(ExternalProject)
6 6 ExternalProject_Add(googletest
7 7 GIT_REPOSITORY https://github.com/google/googletest.git
8   - GIT_TAG master
  8 + GIT_TAG main
9 9 SOURCE_DIR "${CMAKE_BINARY_DIR}/googletest-src"
10 10 BINARY_DIR "${CMAKE_BINARY_DIR}/googletest-build"
11 11 CONFIGURE_COMMAND ""
... ...
README.md
  View file @819155b
... ... @@ -10,7 +10,7 @@ Library for communicating with COM ports on a Linux system.
10 10  
11 11 * Simple API
12 12 * Supports custom baud rates
13   -* cmake based build system
  13 +* `cmake` based build system
14 14  
15 15 ## Installation
16 16  
... ... @@ -51,13 +51,13 @@ Library for communicating with COM ports on a Linux system.
51 51 $ sudo make install
52 52 ```
53 53  
54   -1. To run the unit tests (NOTE: because this uses virtual serial ports via `stty`, this only works on Linux!):
  54 +1. To run the unit tests:
55 55  
56 56 ```bash
57 57 $ make run_unit_tests
58 58 ```
59 59  
60   - If you get errors such as `Could not open device /dev/ttyS10. Is the device name correct and do you have read/write permission?" thrown in the test fixture's constructor.`, it is probably an issue with either creating the virtual serial ports or permissions to access them.
  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!
61 61  
62 62 ## Examples
63 63  
... ... @@ -73,7 +73,7 @@ int main() {
73 73 serialPort.SetTimeout(-1); // Block when reading until any data is received
74 74 serialPort.Open();
75 75  
76   - // Write some ASCII datae
  76 + // Write some ASCII data
77 77 serialPort.Write("Hello");
78 78  
79 79 // Read some data back (will block until at least 1 byte is received due to the SetTimeout(-1) call above)
... ... @@ -103,4 +103,4 @@ See GitHub Issues.
103 103  
104 104 ## Changelog
105 105  
106   -See CHANGELOG.md.
107 106 \ No newline at end of file
  107 +See CHANGELOG.md.
... ...