From 16a2c5c47c0a3587faf4e73e27c5077beaaa2a6f Mon Sep 17 00:00:00 2001
From: Julius Koskela <sub@juliuskoskela.dev>
Date: Fri, 23 Sep 2022 20:15:27 +0300
Subject: [PATCH] Write README

---
 README.md | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)

diff --git a/README.md b/README.md
index e69de29..9346be2 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,20 @@
+# Hydrophonitor
+
+A software package to record audio and related metadata from a configuration
+of hydrophones.
+
+## Overview
+
+Module           | Description
+-----------------|-
+audio-logger     | Receive an audio signal from the DAC and write it on disk in `.wav` format.
+gps-logger       | Record position and time of the device in `.csv` format.
+depth-logger     | Record depth of the device and save it in `.csv` format.
+*lcd-display     | Provide information on the device's LCD screen
+*device-controls | Provide device control using physical buttons.
+
+## Data Formats
+
+Type | Format
+-----|-
+GPS Data |
\ No newline at end of file