Add some instructions

This commit is contained in:
2025-02-27 22:26:40 +00:00
parent 9f094802a6
commit 791e920898
3 changed files with 49 additions and 0 deletions
+2
View File
@@ -1,3 +1,5 @@
/venv
# Gitignore settings for ESPHome # Gitignore settings for ESPHome
# This is an example and may include too much for your use-case. # This is an example and may include too much for your use-case.
# You can modify this file to suit your needs. # You can modify this file to suit your needs.
+46
View File
@@ -1,5 +1,51 @@
# esphome # esphome
## Installation
Recommended: [venv](https://docs.python.org/3/library/venv.html).
```shell
# Optional
$ python3 -m venv venv
$ source venv/bin/activate
$ pip3 install -r requirements.txt
```
## Compiling
```
$ cp -i secrets.yaml{.sample,}
$ cp -i templates/secrets.yaml{.sample,}
# Edit both secrets.yaml files.
# Optional
$ source venv/bin/activate
$ ./reflash.sh compile ''
```
## Running
```
# Optional
$ source venv/bin/activate
$ ./reflash.sh
```
or
```
# Optional
$ source venv/bin/activate
$ esphome run file.yaml
```
Look up list of runnable files inside `reflash.sh` script.
## Hardware: heating ## Hardware: heating
### Photoresistor ### Photoresistor
+1
View File
@@ -0,0 +1 @@
esphome >= 2025.2.1