This commit is contained in:
blueloveTH 2024-09-17 18:47:38 +08:00
parent 4aab227b53
commit 7d6a590e39
7 changed files with 15 additions and 17 deletions

View File

@ -20,7 +20,7 @@ jobs:
run: | run: |
python scripts/gen_docs.py python scripts/gen_docs.py
cd docs cd docs
npm install retypeapp --global npm install retypeapp -g
retype build retype build
################################################### ###################################################
- name: Setup emsdk - name: Setup emsdk

View File

@ -25,7 +25,7 @@
</p> </p>
--- ---
## This branch is in alpha stage. Old implementation was moved to v1.x branch. ## This branch is in beta stage. Old implementation was moved to v1.x branch.
--- ---
pkpy is a lightweight(~15K LOC) Python 3.x interpreter for game scripting, written in C11. pkpy is a lightweight(~15K LOC) Python 3.x interpreter for game scripting, written in C11.
@ -56,8 +56,8 @@ You have two options to integrate pkpy into your project.
#### Use the single header file #### Use the single header file
Download the `pocketpy.h` on our [GitHub Release](https://github.com/pocketpy/pocketpy/releases) page. Download the `pocketpy.h` and `pocketpy.c` on our [GitHub Release](https://github.com/pocketpy/pocketpy/releases) page.
And `#include` it in your project. The header can only be included once. And `#include` it in your project.
#### Use CMake #### Use CMake

View File

@ -1,9 +0,0 @@
---
icon: log
title: 'Upgrade to v2.0'
order: 25
---
pkpy v2.0 is a C11 project instead of C++17. All your existing code for v1.x won't work anymore.
We provide two API sets for v2.0, C-API and pybind11 API (C\+\+17). If you are a C user, use the C-API. If you are a C\+\+ user, use the pybind11 API.

View File

@ -4,7 +4,7 @@ icon: dot
order: 10 order: 10
--- ---
TBA All public functions in the C API are prefixed with `py_` in [pocketpy.h](https://github.com/pocketpy/pocketpy/blob/main/include/pocketpy/pocketpy.h).
### `PY_RAISE` macro ### `PY_RAISE` macro

View File

@ -52,3 +52,10 @@ You can sponsor this project via these ways.
+ [Buy me a coffee](https://www.buymeacoffee.com/blueloveth) + [Buy me a coffee](https://www.buymeacoffee.com/blueloveth)
Your sponsorship will help us develop pkpy continuously. Your sponsorship will help us develop pkpy continuously.
## Upgrade to v2.0
pkpy v2.0 is a C11 project instead of C++17. All your existing code for v1.x won't work anymore.
We provide two API sets for v2.0, C-API and pybind11 API (C\+\+17). If you are a C user, use the C-API. If you are a C\+\+ user, use the pybind11 API.

View File

@ -8,8 +8,8 @@ You have two options to integrate pkpy into your project.
#### Use the single header file #### Use the single header file
Download the `pocketpy.h` on our [GitHub Release](https://github.com/pocketpy/pocketpy/releases) page. Download the `pocketpy.h` and `pocketpy.c` on our [GitHub Release](https://github.com/pocketpy/pocketpy/releases) page.
And `#include` it in your project. The header can only be included once. And `#include` it in your project.
#### Use CMake #### Use CMake

View File

@ -7,7 +7,7 @@ branding:
logo: "./static/logo.png" logo: "./static/logo.png"
favicon: "./static/logo.png" favicon: "./static/logo.png"
meta: meta:
title: " | Open Source Python interpreter in 1 file" title: " | Portable Python 3.x Interpreter in Modern C"
links: links:
- text: "Home" - text: "Home"
icon: home icon: home