Skip to content

Commit

Permalink
Merge pull request #26 from jsiddall/patch-1
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
blakadder committed Sep 30, 2023
2 parents 2a41eea + 46f226d commit 322df82
Showing 1 changed file with 23 additions and 6 deletions.
29 changes: 23 additions & 6 deletions README.md
Expand Up @@ -19,7 +19,28 @@ Script will update the repo folder with the latest one every run.

To check compiling logs use `cat docker-tasmota.log`

## How to use the docker container
## Option 1: Setup the prebuilt docker container using the compile.sh script
1. Clone this repo and cd to the dir where its cloned:
```
git clone https://github.com/tasmota/docker-tasmota
cd docker-tasmota
```
2. Update the `user_config_override.h` and/or `platformio_override.ini` files with your custom build settings
3. Run compile.sh with the desired build name, ex:
```
./compile.sh tasmota
```
If necessary the `compile.sh` script will install the container and Tasmota repo if you type 'yes' when prompted

5. When compiling finishes you should have the compiled binary and gzipped version in `Tasmota/build_output/firmware` which can be flashed on your devices

Note: If you want to update the docker image installed previously by the `compile.sh` script run:
```
docker pull blakadder/docker-tasmota
```

## Option 2: Setup a docker container from scratch

1. Clone this repo and cd to the dir where its cloned:
```
git clone https://github.com/tasmota/docker-tasmota
Expand All @@ -29,13 +50,10 @@ To check compiling logs use `cat docker-tasmota.log`
2. Run this to build the docker container:
`docker build -t docker-tasmota .`

1. _Instead of 1. and 2:_ you can grab the latest docker image with `docker pull blakadder/docker-tasmota`

3. Move to a directory where you want to clone Tasmota repo:
```
git clone https://github.com/arendst/Tasmota.git
```

If you have a `user_config_override.h` or `platformio_override.ini` file with your custom settings, you will need to put them under `Tasmota/tasmota`.

4. From the same directory run to compile the desired build
Expand All @@ -45,7 +63,7 @@ If you have a `user_config_override.h` or `platformio_override.ini` file with yo
5. When compiling finishes you should have the compiled binary and gzipped version in `Tasmota/build_output/firmware` which can be flashed on your devices.

## Switch branch other than development
## Switch to a branch other than development

`cd Tasmota`

Expand All @@ -61,4 +79,3 @@ docker run -ti --rm \
-v $(pwd)/Tasmota:/tasmota \
-u $UID:$GID docker-tasmota
```

0 comments on commit 322df82

Please sign in to comment.