aboutsummaryrefslogtreecommitdiff
path: root/Mussel/README.md
diff options
context:
space:
mode:
authorJonas Smedegaard <dr@jones.dk>2025-03-11 12:02:07 +0100
committerJonas Smedegaard <dr@jones.dk>2025-03-11 16:48:06 +0100
commit02876f961fc8b68f2cb43a23a1d98d89fce11858 (patch)
treed12658d92f62c4fd957fb68e683d75b8f378428f /Mussel/README.md
parent8d0212da635222b404113ad0ff5d469adf00ab6f (diff)
add library Mussel
Diffstat (limited to 'Mussel/README.md')
-rw-r--r--Mussel/README.md36
1 files changed, 36 insertions, 0 deletions
diff --git a/Mussel/README.md b/Mussel/README.md
new file mode 100644
index 0000000..4420e2a
--- /dev/null
+++ b/Mussel/README.md
@@ -0,0 +1,36 @@
+# Mussel
+
+SPDX-FileCopyrightText: 2025 Amal Mazrah <mazrah@ruc.dk>
+SPDX-FileCopyrightText: 2025 Jonas Smedegaard <dr@jones.dk>
+SPDX-FileCopyrightText: 2025 Mennatullah Hatim Kassim <stud-mennatulla@ruc.dk>
+SPDX-FileCopyrightText: 2025 Noor Ahmad <noora@ruc.dk>
+SPDX-FileCopyrightText: 2025 Tanishka Suwalka <tanishkas@ruc.dk>
+SPDX-License-Identifier: GPL-3.0-or-later
+
+Mussel is a tiny library to emulate a mussel biosensor.
+
+## Motivation
+
+For exploration of various biosensor behaviours,
+hooking into various networking setups with various looping constructs,
+maintaining the behaviours as a library seemed convenient.
+
+## Features
+
+* Super simple API
+* Offers multiple behaviours.
+
+## Requirements
+
+* An Arduino — http://arduino.cc/
+
+## Installation
+
+Download the ZIP archive from
+<https://app.radicle.xyz/nodes/seed.radicle.garden/rad:z2tFBF4gN7ziG9oXtUytVQNYe3VhQ>,
+then open the Arduino IDE
+and choose Sketch > Include Library > Add .ZIP Library...
+and select your downloaded file.
+
+You should now see in File > Examples > Mussel
+an entry for the `basic_usage` example.