Skip to content

Commit 280b949

Browse files
committed
📝 docs(documentation): Update project description
1 parent 1e2d13e commit 280b949

File tree

1 file changed

+13
-10
lines changed

1 file changed

+13
-10
lines changed

docs/index.rst

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,11 @@
1-
Welcome to libserial's documentation!
1+
Welcome to CppSerial's documentation!
22
=====================================
33

4-
libserial is a C++ library for serial port communication on Linux systems. It provides a simple and intuitive interface for opening, configuring, and communicating through serial ports.
4+
CppSerial is a C++ library for serial communication on Linux systems. It provides a simple and intuitive interface for opening, configuring, and communicating through serial ports.
5+
6+
The goal of this API is to provide developers with a modern C++ interface to the traditional C header asm/termbits.h.
7+
It allows setting any baud rate supported by the hardware, not just the standard ones, enabling a more flexible communication process that is ideal for industrial or embedded applications requiring non-standard baud rates.
8+
It uses **Object-Oriented Programming concepts**, **smart pointers**, **lambda functions**, and more to give your applications greater flexibility and power when dealing with **serial communication** in a **Linux environment**.
59

610
.. toctree::
711
:maxdepth: 2
@@ -15,10 +19,9 @@ libserial is a C++ library for serial port communication on Linux systems. It pr
1519
Features
1620
--------
1721

18-
* Simple C++ interface for serial port operations
22+
* Simple C++ interface for serial operations
1923
* Support for various baud rates and communication parameters
20-
* Cross-platform compatibility (Linux focus)
21-
* Modern C++14 implementation
24+
* Modern C++17 implementation
2225
* Exception-based error handling
2326

2427
Quick Start
@@ -49,9 +52,9 @@ Here's a simple example of how to use libserial:
4952
return 0;
5053
}
5154
52-
Indices and tables
53-
==================
55+
.. Indices and tables
56+
.. ==================
5457
55-
* :ref:`genindex`
56-
* :ref:`modindex`
57-
* :ref:`search`
58+
.. * :ref:`genindex`
59+
.. * :ref:`modindex`
60+
.. * :ref:`search`

0 commit comments

Comments
 (0)