From b08f35aa11cc7647f980538346913041dec2befd Mon Sep 17 00:00:00 2001 From: Aadi Desai <21363892+supleed2@users.noreply.github.com> Date: Mon, 13 Jun 2022 11:43:05 +0100 Subject: [PATCH] Add overall project readme.md --- readme.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 readme.md diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..aa482cb --- /dev/null +++ b/readme.md @@ -0,0 +1,17 @@ +# ELEC60013 Embedded Systems: Coursework 1 + +## Project name: Barkr + +## Repository Sections + +- [App](./App/): The user app, built in Flutter +- [DataPuller](./DataPuller/): Data fetching script to pull data from cloud sources and forward to our backend, eg. AirTags DB or an MQTT broker +- [RPi](./RPi/): Program to run on the IOT device itself, collects pet information for the app and acts as a bluetooth beacon +- [Server](./Server/): Backend for interacting with the Firebase API and provides user signup abilities +- [Website](./Website/): Static marketting website built using Hugo, live at + +## Contributors + +- [Aadi](https://github.com/supleed2/) +- [Benjamin](https://github.com/bo3z/) +- [Kacper](https://github.com/kmn219/)