diff --git a/bindings/c/README.md b/bindings/c/README.md index 5c964b1b..752b7af0 100644 --- a/bindings/c/README.md +++ b/bindings/c/README.md @@ -3,9 +3,10 @@ ## Instructions Check out `CMakeLists.txt` and change the 3 options to your preference: -`NO_STD`: Enable no_std build, without iota_client (when ON, `SYNC_CLIENT` isnt supported) -`SYNC_CLIENT`: Enable sync transport via iota_client, otherwise goes to async -`STATIC`: Build static library when ON, otherwise dynamic library + +- `NO_STD`: Enable no_std build, without iota_client (when ON, `SYNC_CLIENT` isnt supported) +- `SYNC_CLIENT`: Enable sync transport via iota_client, otherwise it's going to be Bucket which can only be used for tests +- `STATIC`: Build static library when ON, otherwise dynamic library Edit your author and subscriber seeds in `main.c` @@ -14,8 +15,8 @@ run `cmake .` in this folder Then run `make` to build the rust code. A binary will be generated which you can run depending on your STATIC setting -ON: `iota_streams_c_static` -OFF: `libiota_streams_c.so`(Unix), `iota_streams_c.dll`(Windows) and the executable `iota_streams_c` +- ON: `iota_streams_c_static` +- OFF: `libiota_streams_c.so`(Unix), `iota_streams_c.dll`(Windows) and the executable `iota_streams_c` You can then run the static build or the dynamic executable. Keep in mind that by default the code points to a node on `http://localhost:14265`. If this node doesnt exist, we will exit with an error immediately.