✨ feat(serial): readByte method without his implementation

Author: NestorDP

docs/index.rst

@@ -23,38 +23,3 @@ Features
 * Support for various baud rates and communication parameters
 * Modern C++17 implementation
 * Exception-based error handling
-
-Quick Start
------------
-
-Here's a simple example of how to use libserial:
-
-.. code-block:: cpp
-
-   #include <libserial/serial.hpp>
-   #include <iostream>
-
-   int main() {
-       try {
-           libserial::Serial serial("/dev/ttyUSB0");
-           serial.open();
-           serial.write("Hello, World!");
-           
-           std::string response = serial.read();
-           std::cout << "Received: " << response << std::endl;
-           
-           serial.close();
-       } catch (const libserial::SerialException& e) {
-           std::cerr << "Error: " << e.what() << std::endl;
-           return 1;
-       }
-       
-       return 0;
-   }
-
-.. Indices and tables
-.. ==================
-
-.. * :ref:`genindex`
-.. * :ref:`modindex`
-.. * :ref:`search`

docs/installation.rst

@@ -10,7 +10,7 @@ Prerequisites
 To build libserial from source, you'll need:
 
 * CMake (version 3.10 or higher)
-* A C++14 compatible compiler (GCC 5.4+ or Clang 3.4+)
+* A C++17 compatible compiler (GCC 5.4+ or Clang 3.4+)
 * Git (for cloning the repository)
 
 For documentation generation (optional):
@@ -28,8 +28,8 @@ Building the Library
 
 .. code-block:: bash
 
-   git clone https://github.com/NestorDP/libserial.git
-   cd libserial
+   git clone https://github.com/NestorDP/cppserial.git
+   cd cppserial
 
 2. Create a build directory:
 
@@ -69,28 +69,37 @@ You can customize the build with various CMake options:
    # Install to a custom location
    cmake -DCMAKE_INSTALL_PREFIX=/usr/local ..
 
-Package Installation
---------------------
+   # Enable testing
+   cmake -DBUILD_TESTING=ON ..
 
-Ubuntu/Debian
-~~~~~~~~~~~~~
+   # Enable coverage reports
+   cmake -DENABLE_COVERAGE=ON ..
 
-.. code-block:: bash
+   # Enable documentation generation
+   cmake -DBUILD_DOCUMENTATION=ON ..
+
+.. Package Installation
+.. --------------------
+
+.. Ubuntu/Debian
+.. ~~~~~~~~~~~~~
+
+.. .. code-block:: bash
 
-   sudo apt update
-   sudo apt install libserial-dev
+..    sudo apt update
+..    sudo apt install libserial-dev
 
-(Note: Package availability depends on your distribution)
+.. (Note: Package availability depends on your distribution)
 
-From Binary Releases
-~~~~~~~~~~~~~~~~~~~~~
+.. From Binary Releases
+.. ~~~~~~~~~~~~~~~~~~~~~
 
-Download the latest release from the `GitHub releases page <https://github.com/NestorDP/libserial/releases>`_ and follow the installation instructions provided with the release.
+.. Download the latest release from the `GitHub releases page <https://github.com/NestorDP/cppserial/releases>`_ and follow the installation instructions provided with the release.
 
 Verifying Installation
 ----------------------
 
-To verify that libserial is installed correctly, create a simple test program:
+To verify that cppserial is installed correctly, create a simple test program:
 
 .. code-block:: cpp
 
@@ -106,5 +115,5 @@ Compile and run:
 
 .. code-block:: bash
 
-   g++ -std=c++14 test.cpp -lserial -o test
+   g++ -std=c++17 test.cpp -lserial -o test
    ./test

include/libserial/serial.hpp

@@ -119,6 +119,18 @@ void write(std::shared_ptr<std::string> data);
  */
 size_t read(std::shared_ptr<std::string> buffer, size_t max_length);
 
+/**
+ * @brief Read a single byte from the serial port
+ *
+ * Reads one byte from the serial port and stores it in the provided buffer.
+ *
+ * @param buffer Shared pointer to string where the byte will be stored
+ * @return Number of bytes actually read (1 if successful, 0 on error)
+ * @throws SerialException if read operation fails
+ * @throws SerialException if buffer is null
+ */
+void readByte([[maybe_unused]] std::shared_ptr<std::string> buffer);
+
 /**
  * @brief Reads data until a specific terminator character is found
  *

src/serial.cpp

@@ -68,6 +68,10 @@ size_t Serial::read(std::shared_ptr<std::string> buffer, size_t max_length) {
   return static_cast<size_t>(bytes_read);
 }
 
+void Serial::readByte([[maybe_unused]] std::shared_ptr<std::string> buffer) {
+  // Implementation can be added here if needed
+}
+
 size_t Serial::readUntil(std::shared_ptr<std::string> buffer, char terminator) {
   if (!buffer) {
     throw SerialException("Null pointer passed to readUntil function");