Skip to content

Commit 66d9e43

Browse files
authored
Revise example addition instructions in README
Updated instructions for adding new examples and clarified the process for microcontroller programming.
1 parent 7bd26f5 commit 66d9e43

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,12 @@ https://github.com/Electrostat-Lab/Electrostatic-Library/blob/a6d9669dde096c0228
4444

4545
## Adding new examples to test the introduced APIs
4646
* Adding new examples could be achieved by creating new source code (single source files) under the `examples` module, and using the following command to compile and run the example:
47-
47+
```bash
48+
$ ./helper-scripts/project-impl/compile-examples.sh "-m64" "main.cpp" "executable-example" "linux" "x86-64" "x86-64/exe"
49+
$ ./cmake-build/linux/x86-64/exe/executable-example.elf
50+
```
51+
> [!NOTE]
52+
> This command links the specified source example against the `Electrostatic-Sandbox SDK` libraries and the `Electroextension` library (your native library).
4853
4954
* Adding new examples for microcontroller programming is much the same, but will require uploading as a post-compilation script.
5055

0 commit comments

Comments
 (0)