diff --git a/docs/index.md b/docs/index.md index 40a78fe6..8ab4b6a4 100644 --- a/docs/index.md +++ b/docs/index.md @@ -5,7 +5,7 @@ label: Welcome # Welcome to PocketPy -PocketPy is a lightweight(~8000 LOC) Python interpreter for game engines. +pkpy is a lightweight(~8000 LOC) Python interpreter for game engine/apps. It is extremely easy to embed. Including a compiler, optimizer and bytecode virtual machine. All of them are available in a single header file `pocketpy.h`, without external dependencies. @@ -23,19 +23,4 @@ def is_prime(x): primes = [i for i in range(2, 20) if is_prime(i)] print(primes) # [2, 3, 5, 7, 11, 13, 17, 19] -``` - -## Source Integration - -We recommend to use our pre-built `pocketpy.h` in [Github Release](https://github.com/blueloveTH/pocketpy/releases/latest) page. -To compile it with your project, these flags must be set: - -+ `--std=c++17` flag must be set -+ Exception must be enabled -+ RTTI is not required - -!!! -You can use `g++`, `cl.exe` or `clang++` to compile your project. -For maximum performance, we recommend to `clang++` with `-O2` flag. -`clang++` can produce faster binary than `g++` or `cl.exe`. -!!! \ No newline at end of file +``` \ No newline at end of file diff --git a/docs/quick-start/installation.md b/docs/quick-start/installation.md index f42294c8..8c2bce67 100644 --- a/docs/quick-start/installation.md +++ b/docs/quick-start/installation.md @@ -16,6 +16,18 @@ Alternatively, you can install it via vcpkg.io. vcpkg install pocketpy ``` +## Compile flags + +To compile it with your project, these flags must be set: + ++ `--std=c++17` flag must be set ++ Exception must be enabled ++ RTTI is not required + +!!! +For maximum performance, we recommend to use `clang++` with `-O2` flag. +!!! + ## Example ```cpp