diff --git a/README.md b/README.md index d662fa9d..05fde34c 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,41 @@ # pocketpy -## 参考 +![build](https://github.com/blueloveTH/pocketpy/actions/workflows/main.yml/badge.svg) + +`pocketpy` is a C++17 single-file header-only cross platform Python Interpreter. + +![sample_img](docs/readme_sample.png) + +**CURRENTLY IN DEVELOPMENT!!** + +## Prebuilt Windows Binaries + +Go to https://github.com/blueloveTH/pocketpy/actions/workflows/main.yml to get an artifact. + +## Build From Source + +First clone the repository + +```bash +git clone https://github.com/blueloveTH/pocketpy +cd pocketpy +``` + +**If you want to get a single header file:** + +```bash +python3 amalgamate.py +``` + +It will generate `pocketpy.h` and `main.cpp` in `amalgamate/` directory. You can use `main.cpp` to build a REPL console or use `pocketpy.h` only to embed it to your game engine. + +**If you want to do development:** + +```bash +bash build_cpp.sh +``` + +## Reference + [cpython](https://github.com/python/cpython) diff --git a/docs/readme_sample.png b/docs/readme_sample.png new file mode 100644 index 00000000..9787ab8f Binary files /dev/null and b/docs/readme_sample.png differ