Skip to content

Feat improve exemples docs #19

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
NestorDP merged 4 commits into from
Oct 31, 2025
Merged

Feat improve exemples docs #19

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
faaf72a
📝 docs(readme): Remove example section
NestorDP Oct 30, 2025
8b00fe1
📝 docs(usage): Update basic usage
NestorDP Oct 31, 2025
7684e42
📝 docs(examples): Update examples page
NestorDP Oct 31, 2025
cce3564
📝 docs(usage): Fix typo errors
NestorDP Oct 31, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
# CppSerial

# CppSerial
[![release](https://img.shields.io/github/v/release/NestorDP/cppserial)](https://github.com/NestorDP/cppserial/releases)


[![unit-tests](https://github.com/NestorDP/cppserial/actions/workflows/unit-tests.yml/badge.svg)](https://github.com/NestorDP/cppserial/actions/workflows/unit-tests.yml)
[![codecov](https://codecov.io/gh/NestorDP/cppserial/branch/main/graph/badge.svg)](https://codecov.io/gh/NestorDP/cppserial)
[![Documentation Status](https://readthedocs.org/projects/cppserial/badge/?version=latest)](https://cppserial.readthedocs.io/en/latest/?badge=latest)
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/3759133c01204a5c880d0dd65e6175bc)](https://app.codacy.com/gh/NestorDP/cppserial/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
[![Documentation Status](https://readthedocs.org/projects/cppserial/badge/?version=latest)](https://cppserial.readthedocs.io/en/latest/?badge=latest)

<!-- [![License](https://img.shields.io/github/license/NestorDP/cppserial)](https://github.com/NestorDP/cppserial/blob/main/LICENSE) -->
<!--[![coverage](https://github.com/NestorDP/cppserial/actions/workflows/coverage.yml/badge.svg)](https://github.com/NestorDP/cppserial/actions/workflows/coverage.yml)-->
Expand Down Expand Up @@ -97,7 +98,7 @@ cd ..
sphinx-build -b html docs build/docs/html
``` -->

## Run an Example Application
<!-- ## Run an Example Application

You can run an example application to test the libserial library in your environment.
Even without a physical serial device, you can test serial communication using a virtual serial port created with socat.
Expand Down Expand Up @@ -159,7 +160,7 @@ You can also run the list_ports example to display all available serial devices

```bash
./examples/list_ports
```
``` -->


### 🤝 Contributing
Expand Down
Loading