Skip to content

Commit

Permalink
Improve README files
Browse files Browse the repository at this point in the history
  • Loading branch information
DataTriny committed Aug 12, 2023
1 parent 851c07c commit 0107fdf
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 2 additions & 0 deletions bindings/python/README.md
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
# AccessKit

These are the bindings to use AccessKit from Python.
15 changes: 15 additions & 0 deletions bindings/python/examples/pygame/README.md
Original file line number Diff line number Diff line change
@@ -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
```

0 comments on commit 0107fdf

Please sign in to comment.