From 0107fdf6b788386b929e96605f827b5c6b59c1d1 Mon Sep 17 00:00:00 2001 From: DataTriny Date: Sat, 12 Aug 2023 10:22:45 +0200 Subject: [PATCH] Improve README files --- README.md | 6 +++++- bindings/python/README.md | 2 ++ bindings/python/examples/pygame/README.md | 15 +++++++++++++++ 3 files changed, 22 insertions(+), 1 deletion(-) create mode 100644 bindings/python/examples/pygame/README.md diff --git a/README.md b/README.md index fd35a41a4..fe6e65132 100644 --- a/README.md +++ b/README.md @@ -56,7 +56,11 @@ While we expect GUI toolkit developers to eventually integrate AccessKit into th ### Language bindings -UI toolkit developers who merely want to use AccessKit should not be required to use Rust directly. In addition to a direct Rust API, AccessKit provides a C API covering both the core data structures and all platform adapters. This C API can be used from a variety of languages. The Rust source for the C bindings is in [the `bindings/c directory`](https://github.com/AccessKit/accesskit/tree/main/bindings/c). The AccessKit project also provides a pre-built package, including a header file, both dynamic and static libraries, and sample code, for the C API, so toolkit developers won't need to deal with Rust at all. The latest pre-built package can be found in [AccessKit's GitHub releases](https://github.com/AccessKit/accesskit/releases); search for the name "accesskit_c". +UI toolkit developers who merely want to use AccessKit should not be required to use Rust directly. + +AccessKit provides a C API covering both the core data structures and all platform adapters. This C API can be used from a variety of languages. The Rust source for the C bindings is in [the `bindings/c directory`](https://github.com/AccessKit/accesskit/tree/main/bindings/c). The AccessKit project also provides a pre-built package, including a header file, both dynamic and static libraries, and sample code, for the C API, so toolkit developers won't need to deal with Rust at all. The latest pre-built package can be found in [AccessKit's GitHub releases](https://github.com/AccessKit/accesskit/releases); search for the name "accesskit_c". + +Bindings for the Python programming language are also available. Rust source code is in [the `bindings/python directory`](https://github.com/AccessKit/accesskit/tree/main/bindings/python). Releases can be found on [PyPI](https://pypi.org/project/accesskit/) and can be included in your project using `pip`. While many languages can use a C API, we also plan to provide libraries that make it easier to safely use AccessKit from languages other than Rust and C. In particular, we're planning to provide such a library for Java and other JVM-based languages. diff --git a/bindings/python/README.md b/bindings/python/README.md index 8484c0e61..6dc3e133b 100644 --- a/bindings/python/README.md +++ b/bindings/python/README.md @@ -1 +1,3 @@ # AccessKit + +These are the bindings to use AccessKit from Python. diff --git a/bindings/python/examples/pygame/README.md b/bindings/python/examples/pygame/README.md new file mode 100644 index 000000000..cfdb8089d --- /dev/null +++ b/bindings/python/examples/pygame/README.md @@ -0,0 +1,15 @@ +# pygame example + +This directory contains a cross-platform application that demonstrates how to integrate AccessKit with the pygame library. + +## Prerequisites + +- Python 3.7 or higher +- A virtual environment: `python -m venv .venv` (activating it will vary based on your platform) +- `pip install -r requirements.txt` + +## How to run + +```bash +python hello_world.py +```