diff --git a/docs/quick-start/config.md b/docs/quick-start/config.md index f302af4b..e3b90545 100644 --- a/docs/quick-start/config.md +++ b/docs/quick-start/config.md @@ -4,8 +4,19 @@ label: 'Advanced config' order: -2 --- +## Disable os-related features + +If you want to disable os-related features, you can do this before including `pocketpy.h`. + +```cpp +#define PK_ENABLE_OS 0 +#include +``` + +## Full config + You can create a `user_config.h` in the same directory as `pocketpy.h` to override some default settings. -1. Copy [src/config.h](https://github.com/blueloveTH/pocketpy/blob/main/src/config.h) and rename it to `user_config.h`. +1. Copy [src/config.h](https://github.com/blueloveTH/pocketpy/blob/main/include/pocketpy/config.h) and rename it to `user_config.h`. 2. Define a macro `PK_USER_CONFIG_H` in `user_config.h`. This invalidates the default `config.h` and enables your `user_config.h`. 3. Edit `user_config.h` to override default settings. \ No newline at end of file