From 8ce38c32b7f489e6d5effa68f89789ddef3d0f28 Mon Sep 17 00:00:00 2001
From: Capstone 2023 <capstone2023@iotlabserver.(none)>
Date: Wed, 25 Oct 2023 15:03:45 +1100
Subject: [PATCH] Described files in README.

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

diff --git a/README.md b/README.md
index 76b642e..5585398 100644
--- a/README.md
+++ b/README.md
@@ -14,6 +14,48 @@ Install InfluxDB and Grafana on the server according to their official instructi
 
 Ensure to git clone this project into the desired directory and cd into this directory for all instructions that follow.
 
+### Overview of files
+
+config_generator.py
+
+dashboard_generator - used by pi_manager_backend
+
+full_image_sim.py
+
+image_streaming_wrangler.py - used by back end
+
+iot_influxdb.py - imported everywhere
+
+livestream.py - used by image_streaming_wrangler
+
+misc.py - imported everywhere
+
+newapi.py - necesary for pi with makerbots, not in the right place
+
+pi_manager.py - front end
+
+pi_manager_backend.py - main back end
+
+pi_server_api.py - runs on pi
+
+redirector.py - main iotcapstone.space page
+
+email.py, report_pdf.py: email and pdf reports, not yet integrated
+
+save_pics.py - take pictures of makerbot camera
+
+threeamigosrpc.py - Custom RPC for control and images
+
+virtual_lab.py - Simulated machines
+
+camera_types - cameras that can be used on the pi
+
+dashboard_modifiers - general dashbaords such as the hoome page
+
+stls - Stuff to 3D print
+
+machines - Machine files to support monitoring.
+
 ### Configuration files
 
 To set up the configuration files, run:
-- 
GitLab