update readme

This commit is contained in:
Tommy Verrall
2023-02-23 11:53:51 +02:00
parent 905ffc257a
commit f4bee0eed0
+6 -9
View File
@@ -1,9 +1,6 @@
## Binary init checker
### WIP
A simple tool to ensure that all binaries init with the correct format, using the assert.sh library
A simple tool to ensure that all binaries init with the correct format, using the `assert.sh` library
Simply run `./build_and_run.sh $RELEASE_BRANCH` `$CURRENT_PRODUCTION_RELEASE_VERSION`
@@ -11,10 +8,10 @@ For example:
`./build_and_run.sh release/v1.1.11 v1.1.10`
This will run through all the binaries anc check the fields that we expect to be initialised when passing the parameters into nyms core binaries
Currently, this is run on linux based machines as the nym-core binaries are published via a linux build agent
This will run through all the binaries and check the fields that we expect to be initialised when passing the parameters into nyms core binaries
## TODO
- Introduce all binaries
- Sort paths and locations
- Tidy up
- Run in CI
- Create GH workflow and Run in CI