From 5ed9cb7e181d0343dec42f095957c68f78a45238 Mon Sep 17 00:00:00 2001
From: Erriez <Erriez@users.noreply.github.com>
Date: Sat, 4 Aug 2018 14:34:29 +0200
Subject: [PATCH] Rename sources to prevent conflicts with other Arduino
 libraries

---
 CMakeLists.txt                                       | 4 ++--
 README.md                                            | 2 +-
 examples/SerialTerminal/SerialTerminal.ino           | 2 +-
 platformio/src/main.cpp                              | 2 +-
 src/{SerialTerminal.cpp => ErriezSerialTerminal.cpp} | 4 ++--
 src/{SerialTerminal.h => ErriezSerialTerminal.h}     | 8 ++++----
 6 files changed, 11 insertions(+), 11 deletions(-)
 rename src/{SerialTerminal.cpp => ErriezSerialTerminal.cpp} (98%)
 rename src/{SerialTerminal.h => ErriezSerialTerminal.h} (94%)

diff --git a/CMakeLists.txt b/CMakeLists.txt
index cbae38c..deac1bf 100644
--- 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
index 5a8e47b..1eec780 100644
--- 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
index 068da36..44c92ce 100644
--- 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
index 068da36..44c92ce 100644
--- 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 b/src/ErriezSerialTerminal.cpp
similarity index 98%
rename from src/SerialTerminal.cpp
rename to src/ErriezSerialTerminal.cpp
index 3c81de4..5dd2a72 100644
--- a/src/SerialTerminal.cpp
+++ b/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 b/src/ErriezSerialTerminal.h
similarity index 94%
rename from src/SerialTerminal.h
rename to src/ErriezSerialTerminal.h
index fee1b72..b90c577 100644
--- a/src/SerialTerminal.h
+++ b/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_