First version

LCD_I2C.hpp

@@ -78,10 +78,9 @@ class LCD_I2C final
     static constexpr byte COMMAND = 0x00;
     static constexpr byte CHAR = 0x01;
 
-    static constexpr byte CUSTOM_SYMBOL_SIZE = 8;
-
  public:
 
+    static constexpr byte CUSTOM_SYMBOL_SIZE = 8;
     using array = std::array<byte, CUSTOM_SYMBOL_SIZE>;
 
  private:

README.md

@@ -1 +1,27 @@
-# Raspberry Pi Pico - I2C Liquid Crystal Display Library
+# Raspberry Pi Pico - I2C Liquid Crystal Display Library
+
+This repository contains a Raspberry Pi Pico library using its SDK writen for the Liquid Crystal Displays that are equiped with an I2C module. It also contains two examples for two different types of LCDs. Below are the instructions on how to build them.
+
+## Examples
+
+After you clone the repo you run the following commands to build them. You have to have installed *CMake* and *Make*. Also you need to have the SDK on your system and point `PICO_SDK_PATH` to it.
+```sh
+export PICO_SDK_PATH='/Path/to/SDK'
+```
+```sh
+cd Pico-I2C-LCD/examples
+```
+```sh
+mkdir build
+```
+```sh
+cd build
+```
+```sh
+cmake ..
+```
+```sh
+make -j4
+```
+### How to connect the LCD to the board
+![Fritzing drawing](img/fritzing.png)

examples/CMakeLists.txt

@@ -12,7 +12,6 @@ set(CMAKE_CXX_STANDARD 20)
 if (NOT CMAKE_BUILD_TYPE OR CMAKE_BUILD_TYPE STREQUAL "")
     set(CMAKE_BUILD_TYPE "Release" CACHE STRING "" FORCE)
     message("Using by default the Release build")
-    message("To build the Debug version pass the option -DCMAKE_BUILD_TYPE=Debug to CMake")
 endif ()
 
 # Set Debug build compiler arguments