Skip to content

Commit e5dbc26

Browse files
committed
readme: update
1 parent 53ececd commit e5dbc26

File tree

1 file changed

+37
-2
lines changed

1 file changed

+37
-2
lines changed

README.md

Lines changed: 37 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,20 @@ into executables which program the esp chip. It may work for other platforms on
55
espressif chips such as Arduino / Platform.IO, but I have not designed / tested
66
it with those environments.
77

8+
For an example repository which uses this action, please see
9+
[esp-usb-ble-hid](https://github.com/finger563/esp-usb-ble-hid).
10+
11+
<!-- markdown-toc start - Don't edit this section. Run M-x markdown-toc-refresh-toc -->
12+
**Table of Contents**
13+
14+
- [ESP Packaged Programmer Action](#esp-packaged-programmer-action)
15+
- [About](#about)
16+
- [Required Build Artifacts](#required-build-artifacts)
17+
- [Optional Build Artifacts](#optional-build-artifacts)
18+
- [Using this action](#using-this-action)
19+
20+
<!-- markdown-toc end -->
21+
822
## About
923

1024
The output of this action is a binary which requires no other dependencies,
@@ -20,20 +34,41 @@ The primary use case for this action is to be run on releases, so that the
2034
executable will be automatically generated and added to the release for ease of
2135
use.
2236

23-
### Required Build Outputs
37+
```yaml
38+
package:
39+
name: Package the binaries into an executables for Windows, MacOS, and Linux (Ubuntu)
40+
needs: build
41+
strategy:
42+
matrix:
43+
os: [windows-latest, macos-latest, ubuntu-latest]
44+
runs-on: ${{ matrix.os }}
45+
steps:
46+
- uses: esp-cpp/esp-packaged-programmer-action@v1
47+
with:
48+
zipfile-id: ${{ needs.build.outputs.zipfile-id }}
49+
programmer-name: 'your_programmer_name'
50+
```
51+
52+
See the example in [Using this action](#using-this-action) for a more complete
53+
example showing how to build your code and zip it for use by this action.
54+
55+
### Required Build Artifacts
2456
2557
It requires:
2658
- firmware.bin (or whatever the name of your project is, e.g. <project-name>.bin)
2759
- bootloader.bin
2860
- partition-table.bin
2961
- flasher_args.json
3062
31-
### Optional Build Outputs
63+
### Optional Build Artifacts
3264
3365
May optionally contain filesystem binaries and associated -flash_args files such as:
3466
- littlefs.bin
3567
- littlefs-flash_args
3668
69+
It also supports other partition image data such as
70+
- ota_data_initial.bin
71+
3772
## Using this action
3873
3974
Below is an example workflow file that:

0 commit comments

Comments
 (0)