From 3d6c5c60a3c7f6756e3a4ccfa0316b88ae948c61 Mon Sep 17 00:00:00 2001 From: blueloveTH Date: Sun, 13 Apr 2025 19:09:23 +0800 Subject: [PATCH] fix docs --- README.md | 2 +- docs/modules/pkpy.md | 10 ++++++++++ docs/quick-start.md | 2 +- 3 files changed, 12 insertions(+), 2 deletions(-) create mode 100644 docs/modules/pkpy.md diff --git a/README.md b/README.md index 0c63e0ef..192b3a67 100644 --- a/README.md +++ b/README.md @@ -73,7 +73,7 @@ It is safe to use `main` branch in production if CI badge is green. To compile it with your project, these flags must be set: + `--std=c11` flag must be set -+ For MSVC, `/utf-8` flag must be set ++ For MSVC, `/utf-8` and `/experimental:c11atomics` flag must be set + `NDEBUG` macro should be defined for release build, or you will get poor performance For amalgamated build, run `python amalgamate.py` to generate `pocketpy.c` and `pocketpy.h` in `amalgamated/` directory. diff --git a/docs/modules/pkpy.md b/docs/modules/pkpy.md new file mode 100644 index 00000000..f70dcd93 --- /dev/null +++ b/docs/modules/pkpy.md @@ -0,0 +1,10 @@ +--- +icon: package +label: pkpy +--- + +Provide internal access to the pocketpy interpreter. + +#### Source code + +:::code source="../../include/typings/pkpy.pyi" ::: diff --git a/docs/quick-start.md b/docs/quick-start.md index a585e3ab..1be0b83c 100644 --- a/docs/quick-start.md +++ b/docs/quick-start.md @@ -30,7 +30,7 @@ It is safe to use `main` branch in production if CI badge is green. To compile it with your project, these flags must be set: + `--std=c11` flag must be set -+ For MSVC, `/utf-8` flag must be set ++ For MSVC, `/utf-8` and `/experimental:c11atomics` flag must be set + `NDEBUG` macro should be defined for release build, or you will get poor performance ### Get prebuilt binaries