Add sdkconfig.defaults to examples and mention in README

DavidB137 · Oct 8, 2023 · 681af76 · 681af76
1 parent 734c7c6
commit 681af76
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -39,7 +39,15 @@ an access point serving "standard" devices as well as all of IoT.
      spsp:
        git: https://github.com/DavidB137/spsp.git
    ```
-3. Rename `main.c` to `main.cpp` file inside `main` project directory
+3. Create `sdkconfig.defaults` file incide root project directory:
+   ```
+   CONFIG_COMPILER_OPTIMIZATION_SIZE=y
+   CONFIG_COMPILER_CXX_EXCEPTIONS=y
+   ```
+   SPSP uses exceptions, so they need to be enabled in the build process.
+   It may be also necessary to enable size optimalization depending on
+   the flash size.
+4. Rename `main.c` to `main.cpp` file inside `main` project directory
    and change it's content to:
    ```cpp
    #include "spsp.hpp"
@@ -52,7 +60,7 @@ an access point serving "standard" devices as well as all of IoT.
 
 ### Examples
 
-You can find usage examples in `examples/` directory.
+You can find usage examples in [`examples/`](examples/) directory.
 
 
 ### Code documentation

diff --git a/examples/espidf/bridge/sdkconfig.defaults b/examples/espidf/bridge/sdkconfig.defaults
@@ -0,0 +1,2 @@
+CONFIG_COMPILER_OPTIMIZATION_SIZE=y
+CONFIG_COMPILER_CXX_EXCEPTIONS=y
diff --git a/examples/espidf/client/sdkconfig.defaults b/examples/espidf/client/sdkconfig.defaults
@@ -0,0 +1,2 @@
+CONFIG_COMPILER_OPTIMIZATION_SIZE=y
+CONFIG_COMPILER_CXX_EXCEPTIONS=y