aboutsummaryrefslogtreecommitdiff
path: root/Mussel
diff options
context:
space:
mode:
authorJonas Smedegaard <dr@jones.dk>2025-03-11 20:39:51 +0100
committerJonas Smedegaard <dr@jones.dk>2025-03-11 20:39:51 +0100
commit8bc63d6bae90de16a81090d45f1c93425419ef6c (patch)
tree47ef8448daa137fa5f9f65362a1509206b01b4c2 /Mussel
parent6d00ebd75e9e801bc0f10e93beb76a84d6a06f5d (diff)
reorder sections
Diffstat (limited to 'Mussel')
-rw-r--r--Mussel/README.md34
1 files changed, 18 insertions, 16 deletions
diff --git a/Mussel/README.md b/Mussel/README.md
index 24cf4ca..994f3a7 100644
--- a/Mussel/README.md
+++ b/Mussel/README.md
@@ -1,14 +1,18 @@
# 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.
+## Installation
+
+Download the ZIP archive from the `Raw` link at
+<https://app.radicle.xyz/nodes/seed.radicle.garden/rad:z2tFBF4gN7ziG9oXtUytVQNYe3VhQ/tree/Mussel.zip>,
+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.
+
## Motivation
For exploration of various biosensor behaviours,
@@ -24,13 +28,11 @@ maintaining the behaviours as a library seemed convenient.
* An Arduino — http://arduino.cc/
-## Installation
-
-Download the ZIP archive from the `Raw` link at
-<https://app.radicle.xyz/nodes/seed.radicle.garden/rad:z2tFBF4gN7ziG9oXtUytVQNYe3VhQ/tree/Mussel.zip>,
-then open the Arduino IDE
-and choose Sketch > Include Library > Add .ZIP Library...
-and select your downloaded file.
+## Copyright and licensing
-You should now see in File > Examples > Mussel
-an entry for the `basic_usage` example.
+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