Rename sources to prevent conflicts with other Arduino libraries

Erriez · Aug 4, 2018 · 5ed9cb7 · 5ed9cb7
1 parent c7bf1ab
commit 5ed9cb7
Show file tree

Hide file tree

Showing 6 changed files with 11 additions and 11 deletions.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -51,9 +51,9 @@ include_directories(${LIB_SRC_DIR})
 generate_arduino_library(
         ${PROJECT_NAME}Lib
         SRCS
-            ${LIB_SRC_DIR}/SerialTerminal.cpp
+            ${LIB_SRC_DIR}/ErriezSerialTerminal.cpp
         HDRS
-            ${LIB_SRC_DIR}/SerialTerminal.h
+            ${LIB_SRC_DIR}/ErriezSerialTerminal.h
 )
 
 # Configure project

diff --git a/README.md b/README.md
@@ -35,7 +35,7 @@ Default newline character: ```'\n'```
 Default delimiter character: ```Space```
 
 ```c++
-#include <SerialTerminal.h>
+#include <ErriezSerialTerminal.h>
 
 // Newline character '\r' or '\n'
 char newlineChar = '\n'; 

diff --git a/examples/SerialTerminal/SerialTerminal.ino b/examples/SerialTerminal/SerialTerminal.ino
@@ -29,7 +29,7 @@
  *      Documentation:  https://erriez.github.io/ErriezSerialTerminal
  */
 
-#include <SerialTerminal.h>
+#include <ErriezSerialTerminal.h>
 
 // LED pin
 #define LED_PIN     LED_BUILTIN

diff --git a/platformio/src/main.cpp b/platformio/src/main.cpp
@@ -29,7 +29,7 @@
  *      Documentation:  https://erriez.github.io/ErriezSerialTerminal
  */
 
-#include <SerialTerminal.h>
+#include <ErriezSerialTerminal.h>
 
 // LED pin
 #define LED_PIN     LED_BUILTIN

diff --git a/src/SerialTerminal.cpp → src/ErriezSerialTerminal.cpp b/src/SerialTerminal.cpp → src/ErriezSerialTerminal.cpp
@@ -23,14 +23,14 @@
  */
 
 /*!
+ * \file ErriezSerialTerminal.cpp
  * \brief Serial terminal library for Arduino.
- * \file SerialTerminal.cpp
  * \details
  *      Source:         https://github.com/Erriez/ErriezSerialTerminal
  *      Documentation:  https://erriez.github.io/ErriezSerialTerminal
  */
 
-#include "SerialTerminal.h"
+#include "ErriezSerialTerminal.h"
 
 /*!
  * \brief SerialTerminal constructor.

diff --git a/src/SerialTerminal.h → src/ErriezSerialTerminal.h b/src/SerialTerminal.h → src/ErriezSerialTerminal.h
@@ -23,15 +23,15 @@
  */
 
 /*!
+ * \file ErriezSerialTerminal.h
  * \brief Serial terminal library for Arduino
- * \file SerialTerminal.h
  * \details
  *      Source:         https://github.com/Erriez/ErriezSerialTerminal
  *      Documentation:  https://erriez.github.io/ErriezSerialTerminal
  */
 
-#ifndef SERIAL_TERMINAL_H_
-#define SERIAL_TERMINAL_H_
+#ifndef ERRIEZ_SERIAL_TERMINAL_H_
+#define ERRIEZ_SERIAL_TERMINAL_H_
 
 #include <Arduino.h>
 #include <string.h>
@@ -80,4 +80,4 @@ class SerialTerminal
     void (*_defaultHandler)(const char *);
 };
 
-#endif // SERIAL_TERMINAL_H_
+#endif // ERRIEZ_SERIAL_TERMINAL_H_