docs: add contributing guide and readme
This commit is contained in:
parent
6ee6bfbdee
commit
23cd5740a9
34
CONTRIBUTING.md
Normal file
34
CONTRIBUTING.md
Normal file
@ -0,0 +1,34 @@
|
||||
# Contributing guide
|
||||
|
||||
<a name="commit-message-format"></a>
|
||||
## Commit message format
|
||||
The project uses [this](https://www.conventionalcommits.org/en/v1.0.0/)
|
||||
commit message standard:
|
||||
```gitcommit
|
||||
<type>(<scope>): <subject>
|
||||
<BLANK LINE>
|
||||
[optional body]
|
||||
<BLANK LINE>
|
||||
[optional footer]
|
||||
```
|
||||
|
||||
|
||||
<a name="git-tag-format"></a>
|
||||
## Git Tag format
|
||||
A tag is set on the commit for the next version release in [Semantic
|
||||
Versioning](https://semver.org/) format: `MAJOR.MINOR.PATCH` with the prefix
|
||||
`v` (e.g., `v0.1.2`).
|
||||
```sh
|
||||
git tag -a 'v0.1.2' -m "Fix v0.1.2"
|
||||
git push --tags
|
||||
```
|
||||
|
||||
When releasing a new version, all changes must be documented in
|
||||
[CHANGELOG.md](CHANGELOG.md)
|
||||
|
||||
|
||||
## Сохранение конфига
|
||||
```sh
|
||||
. ~/playground/esp-idf/export.sh
|
||||
idf.py save-defconfig
|
||||
```
|
||||
11
README.md
11
README.md
@ -1,9 +1,8 @@
|
||||
# Pump controller ESP32
|
||||
|
||||
|
||||
|
||||
|
||||
Сохранение конфига:
|
||||
## Сборка и прошивка
|
||||
```sh
|
||||
. ~/playground/esp-idf/export.sh
|
||||
idf.py save-defconfig
|
||||
PORT="/dev/ttyUSB0" \
|
||||
ESP_IDF="~/playground/esp-idf/"
|
||||
just build flash
|
||||
```
|
||||
|
||||
10
justfile
10
justfile
@ -1,17 +1,17 @@
|
||||
#!/usr/bin/env -S just --justfile
|
||||
|
||||
PORT := env("PORT", "/dev/ttyUSB0")
|
||||
ESPRESSIF := env("ESPRESSIF", "${HOME}/playground/esp-idf")
|
||||
ESP_IDF := env("ESP_IDF", "${HOME}/playground/esp-idf")
|
||||
|
||||
|
||||
init:
|
||||
#!/bin/sh
|
||||
. "{{ESPRESSIF}}/export.sh"
|
||||
. "{{ESP_IDF}}/export.sh"
|
||||
idf.py set-target esp32
|
||||
|
||||
build:
|
||||
#!/bin/sh
|
||||
. "{{ESPRESSIF}}/export.sh"
|
||||
. "{{ESP_IDF}}/export.sh"
|
||||
xxd -i assets/index.html > main/frontend.h
|
||||
idf.py build
|
||||
|
||||
@ -19,12 +19,12 @@ build:
|
||||
alias flash := upload
|
||||
upload:
|
||||
#!/bin/sh
|
||||
. "{{ESPRESSIF}}/export.sh"
|
||||
. "{{ESP_IDF}}/export.sh"
|
||||
idf.py -p "{{PORT}}" flash
|
||||
|
||||
|
||||
alias term := monitor
|
||||
monitor:
|
||||
#!/bin/sh
|
||||
. "{{ESPRESSIF}}/export.sh"
|
||||
. "{{ESP_IDF}}/export.sh"
|
||||
idf.py -p "{{PORT}}" monitor
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user