From 9312f51bd2458cc4bcde20e94d55ecc1d1ba3a3b Mon Sep 17 00:00:00 2001 From: Oliver Cullis Date: Wed, 4 Sep 2024 16:09:39 +0200 Subject: [PATCH] readme update --- readme.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/readme.md b/readme.md index 4539fc3..6c1aee1 100644 --- a/readme.md +++ b/readme.md @@ -1,3 +1,11 @@ # Code for TMP117 + Pico W Temperature Measurement System -A "global_config.json" file is required for the code to run. Here, all the settings are defined. An example is given in "example_global_config.json". \ No newline at end of file +This code is indended to run on a Pico W running Micropython. + +## To run on a Pico W: + - Download this repository and copy these files onto the Micropython filesystem via USB (this can be accomplished using Thonny, the VSCode extension "MicroPico" etc). + - Write a "global_config.json" file (see the example for a template), which defines various settings, I2C buses, and connected sensors. + - Once the microcontroller is reset, the main.py file will execute and the code will run. + + +To work on this code, you will need a Micropython editor. I recommend VSCode + MicroPico extension written by paulober (GitHub). \ No newline at end of file