Zxc200611/pocketpy
1
0
Fork 0
mirror of https://github.com/pocketpy/pocketpy synced 2026-02-04 06:30:17 +00:00
Code Issues Packages Projects Releases Wiki Activity

update docs

Browse Source
This commit is contained in:
blueloveTH 2026-01-06 16:29:31 +08:00
parent f10cc37c63
commit 5f8d9fefc3
5 changed files with 18 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -49,17 +49,13 @@ These platforms are officially tested.
+ iOS 64-bit + iOS 64-bit
+ Emscripten 32-bit + Emscripten 32-bit
+ Raspberry Pi OS 64-bit + Raspberry Pi OS 64-bit
+ [Luckfox Pico SDK](https://github.com/LuckfoxTECH/luckfox-pico) 32-bit
## Quick Start ## Quick Start
You have two options to integrate pkpy into your project. You have two options to integrate pkpy into your project.
#### Use the single header file #### Use CMake (Recommended)
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
Clone the whole repository as a submodule into your project, Clone the whole repository as a submodule into your project,
In your CMakelists.txt, add the following lines: In your CMakelists.txt, add the following lines:
@ -73,6 +69,11 @@ See [CMakeLists.txt](https://github.com/pocketpy/pocketpy/blob/main/CMakeLists.t
It is safe to use `main` branch in production if CI badge is green. It is safe to use `main` branch in production if CI badge is green.
#### Use the single header file
Download the `pocketpy.h` and `pocketpy.c` on our [GitHub Release](https://github.com/pocketpy/pocketpy/releases) page.
And `#include` it in your project.
### Compile Flags ### Compile Flags
To compile it with your project, these flags must be set: To compile it with your project, these flags must be set:

6
docs/features/deploy.md
View File

@ -8,9 +8,9 @@ order: 81
The feature requires pocketpy version >= `2.1.7` The feature requires pocketpy version >= `2.1.7`
!!! !!!
You can deploy your pocketpy program as bytecode files. You can deploy your pocketpy program as bytecode files, which slightly improves the loading speed of your program.
It provides some sort of code obfuscation and may slightly improve the loading speed of your program.
It makes your users unable to get your source code directly, unless they do expensive reverse engineering. It also makes your users unable to get your source code directly, unless they do expensive reverse engineering.
To compile a `.py` file into a `.pyc` bytecode file, you need the command-line executable `main`, To compile a `.py` file into a `.pyc` bytecode file, you need the command-line executable `main`,
which can be simply built by running `python cmake_build.py` in the repository root. which can be simply built by running `python cmake_build.py` in the repository root.

2
docs/features/differences.md
View File

@ -22,7 +22,7 @@ The easiest way to test a feature is to [try it on your browser](https://pocketp
1. Descriptor protocol `__get__` and `__set__`. However, `@property` is implemented. 1. Descriptor protocol `__get__` and `__set__`. However, `@property` is implemented.
2. `__slots__` in class definition. 2. `__slots__` in class definition.
3. `else` clause in try..except. 3. `else` and `finally` clause in try..except.
4. Inplace methods like `__iadd__` and `__imul__`. 4. Inplace methods like `__iadd__` and `__imul__`.
5. `__del__` in class definition. 5. `__del__` in class definition.
6. Multiple inheritance. 6. Multiple inheritance.

1
docs/index.md
View File

@ -44,6 +44,7 @@ These platforms are officially tested.
+ iOS 64-bit + iOS 64-bit
+ Emscripten 32-bit + Emscripten 32-bit
+ Raspberry Pi OS 64-bit + Raspberry Pi OS 64-bit
+ [Luckfox Pico SDK](https://github.com/LuckfoxTECH/luckfox-pico) 32-bit
## Star the repo ## Star the repo

12
docs/quick-start.md
View File

@ -6,12 +6,7 @@ label: Quick Start
You have two options to integrate pkpy into your project. You have two options to integrate pkpy into your project.
#### Use the single header file #### Use CMake (Recommended)
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
Clone the whole repository as a submodule into your project, Clone the whole repository as a submodule into your project,
In your CMakelists.txt, add the following lines: In your CMakelists.txt, add the following lines:
@ -25,6 +20,11 @@ See [CMakeLists.txt](https://github.com/pocketpy/pocketpy/blob/main/CMakeLists.t
It is safe to use `main` branch in production if CI badge is green. It is safe to use `main` branch in production if CI badge is green.
#### Use the single header file
Download the `pocketpy.h` and `pocketpy.c` on our [GitHub Release](https://github.com/pocketpy/pocketpy/releases) page.
And `#include` it in your project.
### Compile flags ### Compile flags
To compile it with your project, these flags must be set: To compile it with your project, these flags must be set: