v0.1.2

* Added more documentation.
* Fixed function definitions.
* Tidied up the files.

.vscode/settings.json

@@ -1,6 +1,11 @@
 {
   "files.associations": {
     "array": "cpp",
-    "string": "cpp"
+    "string": "cpp",
+    "*.tcc": "cpp",
+    "unordered_map": "cpp",
+    "functional": "cpp",
+    "string_view": "cpp",
+    "streambuf": "cpp"
   }
 }

Changes.md

@@ -1,10 +1,20 @@
 
+#
+### **+05:30 12:52:48 AM 31-03-2024, Sunday**
+
+  * Added more documentation.
+  * Fixed function define inconsistencies.
+  * Tidied up the files for Arduino release.
+  * Version 🆕 `0.1.2`.
+
+#
 ### **+05:30 12:28:04 AM 13-07-2023, Thursday**
 
   * Updated documentation.
   * Fixed variable name issues.
   * Version 🆕 `0.1.1`.
 
+#
 ### **+05:30 11:42:21 PM 12-07-2023, Wednesday**
 
   * First commit.

Keywords.txt

@@ -30,5 +30,3 @@ getDataRef                   KEYWORD2
 # Constants (LITERAL1)
 #######################################
 
-PT_MODE_ONESHOT   LITERAL1
-

README.md

@@ -1,4 +1,40 @@
 
 # CSE_GNSS
 
-CSE_GNSS is a generic Arduino library from *CIRCUITSTATE Electronics* to read and write any GPS/GNSS module that supports NMEA output over UART. You can define the NMEA sentence formats however you want and extract the data coming from the GNSS module.
+**CSE_GNSS** is a generic Arduino library from **CIRCUITSTATE Electronics** to read and write any GPS/GNSS module that supports **NMEA** output over UART. You can define the NMEA sentence in any custom formats and extract the data coming from the GNSS module.
+
+This library is in pre-release stage. Any feedback is highly appreciated.
+
+# Installation
+
+This library is available from the official **Arduino Library Manager**. Open the Arduino IDE, search for `CSE_GNSS` and install the latest version of the library.
+
+Additionally, you can download the latest release package from the GitHub repository and install it manually. To do so, open the Arduino IDE, go to `Sketch > Include Library > Add .ZIP Library…`​ and select the downloaded file.
+
+Another method is to clone the GitHub repository directly into your libraries folder. The development branch will have the latest features, bug fixes and other changes. To do so, navigate to your `libraries` folder (usually located at `Documents/Arduino/libraries` on Windows and `~/Documents/Arduino/libraries` on macOS) and execute the following command:
+
+```
+git clone https://github.com/CIRCUITSTATE/CSE_GNSS.git
+```
+
+The library can also be installed via **PlatformIO**. All officially listed Arduino listed libraries are automatically fetched by PlatformIO. Use the `lib_deps` search option to install the library.
+
+# Examples
+
+Two example sketches are included with this library which you can find inside the `examples` folder.
+
+* `Print_GPRMC` - Directly reads the NMEA output from the GNSS module and prints it on the serial monitor.
+* `View_GNSS_Data` - Reads the NMEA output from the GNSS module, extract the data and prints it on the serial monitor in key-value format.
+
+# Tutorial
+
+A complete tutorial on GPS/GNSS is available on the [CIRCUITSTATE website](https://www.circuitstate.com/tutorials/what-is-gps-gnss-how-to-interface-ublox-neo-6m-gps-module-with-arduino/). This tutorial uses the **u-blox NEO-6M GY-NEO6MV2** GPS module wired with a **FireBeetle-ESP32E** board.
+
+# API Documentation
+
+The API documentation is available at [API.md](/docs/API.md).
+
+# References
+
+1. [What is GPS/GNSS & How to Interface u-blox NEO-6M GPS Module with Arduino - CIRCUITSTATE Electronics](https://www.circuitstate.com/tutorials/what-is-gps-gnss-how-to-interface-ublox-neo-6m-gps-module-with-arduino/)
+