From 4929b9d24717488f79b2f5e60746d9d0cf50eacd Mon Sep 17 00:00:00 2001 From: blueloveTH Date: Sun, 14 Jan 2024 14:45:02 +0800 Subject: [PATCH] ... --- README.md | 6 ++++-- docs/quick-start/installation.md | 2 ++ 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 04b6cf9e..aaf8c53d 100644 --- a/README.md +++ b/README.md @@ -45,11 +45,13 @@ These platforms are officially tested. Download the `pocketpy.h` on our [GitHub Release](https://github.com/blueloveTH/pocketpy/releases) page. And `#include` it in your project. -You can also use cmake to build it from source. See CMakeLists.txt for details. +You can also use cmake to build it from source. See [CMakeLists.txt](https://github.com/blueloveTH/pocketpy/blob/main/CMakeLists.txt) for details. These variables can be set to control the build process: -+ `PK_BUILD_STATIC_LIB` - Build the static library ++ `PK_BUILD_STATIC_LIB` - Build the static library (default, recommended) + `PK_BUILD_SHARED_LIB` - Build the shared library +It is safe to use `main` branch in production. + ### Compile Flags To compile it with your project, these flags must be set: diff --git a/docs/quick-start/installation.md b/docs/quick-start/installation.md index df5ec906..5def2d9b 100644 --- a/docs/quick-start/installation.md +++ b/docs/quick-start/installation.md @@ -36,6 +36,8 @@ These variables can be set to control the build process: See [CMakeLists.txt](https://github.com/blueloveTH/pocketpy/blob/main/CMakeLists.txt) for details. +It is safe to use `main` branch in production. + ### Compile flags To compile it with your project, these flags must be set: