Merge branch 'develop'

Release v1.0.0

CHANGELOG.md

@@ -0,0 +1,13 @@
+# Change Log
+
+This file records all significant changes in release of the project. Releases are sorted with the latest release first.
+
+## v1.0.0 - 2024-12-27
+
+* Fixed a bug in `debug.h` to ensure the file is only included once.
+* Added change log in `CHANGELOG.md`.
+* Rewrote `README.md`.
+
+## v0.1.0-beta - 2024-04-30
+
+First beta release.

README.md

@@ -1,7 +1,23 @@
 # gate-alarm
 
-🚧 Under construction 🚧
+## Overview
 
-Project to sense when a gate is opened and to sound an alarm when this happens.
+A electronics project to sense when a gate is opened and to sound an alarm when this happens.
 
-This repository contains the project's microcontroller source code as it is developed. A description of the project along with details of progress can be found on the [Gate Alarm](https://cahamo.delphidabbler.com/projects/gate-alarm/) page of the [Cahamo](https://cahamo.delphidabbler.com) website.
+A description of the project along with details of progress can be found on the [Gate Alarm](https://cahamo.delphidabbler.com/projects/gate-alarm/) page of the [Cahamo](https://cahamo.delphidabbler.com) website.
+
+This repository contains the project's microcontroller source code.
+
+## Source Code
+
+The source code was developed in VSCode using the PlatformIO extension. It is written for the Arduino framework in C++. The code is targetted at an Arduino Nano.
+
+In addition to the Arduino library some 3rd party libraries are required. See `platformio.ini` for details.
+
+## Change Log
+
+See `CHANGELOG.md` for details of changes in each release.
+
+## License
+
+The source code contained in this repository is [MIT Licensed](https://cahamo.mit-license.org/).

controller/src/debug.h

@@ -5,7 +5,8 @@
  * DEBUG macro is defined.
  */
 
-#ifndef _DEBUG_H
+#ifndef DEBUG_H
+
 #define DEBUG_H
 
 #ifdef DEBUG