Zxc200611/pocketpy
1
0
Fork 0
mirror of https://github.com/pocketpy/pocketpy synced 2025-10-20 11:30:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix docs

Browse Source
This commit is contained in:
blueloveTH 2025-04-13 19:09:23 +08:00
parent 6fcdea7ef8
commit 3d6c5c60a3
3 changed files with 12 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -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: To compile it with your project, these flags must be set:
+ `--std=c11` flag 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 + `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. For amalgamated build, run `python amalgamate.py` to generate `pocketpy.c` and `pocketpy.h` in `amalgamated/` directory.

10
docs/modules/pkpy.md Normal file
View File

@ -0,0 +1,10 @@
---
icon: package
label: pkpy
---
Provide internal access to the pocketpy interpreter.
#### Source code
:::code source="../../include/typings/pkpy.pyi" :::

2
docs/quick-start.md
View File

@ -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: To compile it with your project, these flags must be set:
+ `--std=c11` flag 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 + `NDEBUG` macro should be defined for release build, or you will get poor performance
### Get prebuilt binaries ### Get prebuilt binaries