edouard.paris / crosspoint-reader
A fork of https://github.com/crosspoint-reader/crosspoint-reader
0
fork

Configure Feed

Select the types of activity you want to include in your feed.

fix: Correct `debugging_monitor.py` script instructions (#676)

## Summary

**What is the goal of this PR?**
- Minor correction to the `debugging_monitor.py` script instructions

**What changes are included?**
- `pyserial` should be installed, NOT `serial`, which is a [different
lib](https://pypi.org/project/serial/)
- Added macOS serial port

## Additional Context

- Just a minor docs update. I can confirm the debugging script is
working great on macOS

---

### AI Usage

While CrossPoint doesn't have restrictions on AI tools in contributing,
please be transparent about their usage as it
helps set the right context for reviewers.

Did you use AI tools to help write this code? _**< NO >**_

authored by

Jake Kenneally and committed by
GitHub 78d6e593 dac11c3f

+7 -2
+7 -2
README.md
··· 102 102 First, make sure all required Python packages are installed: 103 103 104 104 ```python 105 - python3 -m pip install serial colorama matplotlib 105 + python3 -m pip install pyserial colorama matplotlib 106 106 ``` 107 107 after that run the script: 108 108 ```sh 109 + # For Linux 110 + # This was tested on Debian and should work on most Linux systems. 109 111 python3 scripts/debugging_monitor.py 112 + 113 + # For macOS 114 + python3 scripts/debugging_monitor.py /dev/cu.usbmodem2101 110 115 ``` 111 - This was tested on Debian and should work on most Linux systems. Minor adjustments may be required for Windows or macOS. 116 + Minor adjustments may be required for Windows. 112 117 113 118 ## Internals 114 119