1
0
blueloveTH 1 жил өмнө
parent
commit
7d6a590e39

+ 1 - 1
.github/workflows/website.yml

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

+ 3 - 3
README.md

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

+ 0 - 9
docs/2_0.md

@@ -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.

+ 1 - 1
docs/C-API/introduction.md

@@ -4,7 +4,7 @@ icon: dot
 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

+ 7 - 0
docs/index.md

@@ -52,3 +52,10 @@ You can sponsor this project via these ways.
 + [Buy me a coffee](https://www.buymeacoffee.com/blueloveth)
 
 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.
+

+ 2 - 2
docs/quick-start.md

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

+ 1 - 1
docs/retype.yml

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