creating2morrow/neveko
1
0
Fork 0
mirror of https://github.com/creating2morrow/neveko.git synced 2025-03-25 16:49:05 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

update README.md

Browse source
This commit is contained in:
creating2morrow 2023-05-07 04:10:04 -04:00
parent f85ca6537b
commit 3c7b5f4da1
1 changed files with 27 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

27
README.md
View file

@ -25,6 +25,33 @@ NEVidebla-MESago (invisible message)
* `cd nevmes && ./scripts/build_all_and_run.sh "-- -h"` * `cd nevmes && ./scripts/build_all_and_run.sh "-- -h"`
* gui built with rust [egui](https://docs.rs/egui/latest/egui/) * gui built with rust [egui](https://docs.rs/egui/latest/egui/)
## Contributing and Releasing
```bash
| branch | |tag and release|
dev -----------------|-------------------------------------------->
v0.1.0 -----------tag v0.1.0 (delete branch)
v0.2.0 |-------------------------------------------->
main -------------------------------------------------------------->
```
* code on dev branch
* pull request to dev branch
* merge dev to vX.X.X
* merge vX.X.X to main
* tag release v.X.X.X every friday (if stable changes)
* release binaries from the `cargo-build-release` workflow with notes
* create next v.X.X+1.X branch and delete old release branch
* release bug fixes as appropriate to v.X.X.X+1 branch when ready
## Workflows
|name | branch | purpose |
|-- |-- |-- |
|cargo-build | main,dev | ensure code compilation and build success |
|cargo-audit | main,dev | run security audit against RustSec database |
|cargo-build-release | `v0.*` | publish production ready binaries |
## API ## API
* remote/programmatic access * remote/programmatic access