From 3a39be597e1860beb991acf293d28e20edc56eb4 Mon Sep 17 00:00:00 2001 From: jptrsn Date: Mon, 10 Dec 2018 14:08:30 -0500 Subject: [PATCH] Updated readme to include instructions to duplicate settings file locally --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index d85c901..6266042 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,8 @@ This depends heavily on the hard work done by [pcbreflux](https://github.com/pcb ## Getting Started You can get started by cloning this repository to your local machine using git. Alternatively, you can [download the zip](https://github.com/jptrsn/ESP32-mqtt-room/archive/master.zip). To get the code onto your device, you can load it via the Arduino IDE or, thanks to some great work by [kylegordon](https://github.com/kylegordon), you can now build and upload using PlatformIO. +Create a copy of the `Settings.h` file, and rename it to `Settings_local.h`. This will allow you to set your own configuration without the risk of any commits to the repository of sensitive information. + Open the folder in Atom, using the `open project` option in the PlatformIO Home screen. Modify the settings in the `Settings_local.h` file to match your environment. Set the correct port in the `platformio.ini` file (or remove the line to use auto-detection), and upload to the board. Open the serial monitor after successful upload to check for success. ## Home Assistant Configuration