From bd19351c5f9a5d668d89d8c3a66e3f0c27239fc7 Mon Sep 17 00:00:00 2001 From: Yvan Date: Sun, 20 Jul 2025 19:10:39 +0100 Subject: [PATCH] improve the README --- README.md | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 1b36169..5ae0971 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,10 @@ # hortitel -Allotment Telemetry Project: Horti(culture)Tel(emetry) +## Horti(culture)Tel(emetry) +### Allotment Telemetry Project -Project Goal: Gather various sensor data from our allotment so we can observe present data and compare to past measurements. +**Project Goal:** Gather various sensor data from our allotment so we can observe present data and compare to past measurements. -This is initially using the Melopero Perpetuo LoRa boards as documented in their project here: +This is implemented using the Melopero Perpetuo LoRa boards as documented in their project here: [Melopero Perpetuo LoRa](https://github.com/melopero/Melopero_Perpetuo_Lora) The code is derived from their initial examples. @@ -18,8 +19,15 @@ The data is sent and received by serialisation and deserialisation of some structs. It could well be neater to use a text format for, but I'm a bit old-school like this. +This project is very far from being a working thing... but I'm getting it +uploaded as perhaps the more involved examples of sending and receiving data +will be useful to someone. + Eventually I plan to build this out by adding more sensors, a proper enclosure, and an external solar/battery power-source. + +### Disclaimer + The code is in no way warranted to be fit for any purpose at all. In fact it is almost certainly "buggy as hell". You have been warned.