Skip to content

Commit dc4625b

Browse files
authored
docs: create README.md
1 parent 98b48dd commit dc4625b

File tree

1 file changed

+58
-0
lines changed

1 file changed

+58
-0
lines changed

README.md

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
# <h1 align="center">pilotlight-python</h1>
2+
3+
<p align="center">Python bindings for the <a href="https://github.com/PilotLightTech/pilotlight">Pilot Light</a> real‑time application framework.</p>
4+
5+
<h1></h1>
6+
7+
<p align="center">
8+
<a href="https://github.com/PilotLightTech/pilotlight-python/actions?workflow=Build"><img src="https://github.com/PilotLightTech/pilotlight-python/actions/workflows/build.yml/badge.svg?branch=master" alt="build"></a>
9+
<a href="https://pypi.org/project/pilotlight/"><img src="https://img.shields.io/pypi/v/pilotlight?label=pilotlight" alt="PYPI"></a>
10+
</p>
11+
12+
<p align="center">
13+
<a href="#information">Information</a> •
14+
<a href="#installation">Installation</a> •
15+
<a href="#usage">Usage</a> •
16+
<a href="#developer-notes">Developer Notes</a> •
17+
<a href="#license">License</a>
18+
</p>
19+
20+
---
21+
22+
## Information
23+
24+
**pilotlight-python** provides a lightweight set of Python bindings for the core Pilot Light engine.
25+
These bindings allow Python developers to:
26+
27+
- script and prototype real‑time applications
28+
- automate in‑engine workflows
29+
- perform high‑level tooling or data processing
30+
- drive engine behavior from Python instead of C/C++
31+
32+
## Installation
33+
34+
Install from PyPI:
35+
36+
```bash
37+
pip install pilotlight
38+
```
39+
40+
## Usage
41+
42+
WIP
43+
44+
### Accessing Engine Systems
45+
46+
WIP
47+
48+
## Developer Notes
49+
50+
WIP
51+
52+
### Repository Structure
53+
54+
WIP
55+
56+
## License
57+
58+
pilotlight-python is licensed under the **MIT License**, matching the core Pilot Light engine.

0 commit comments

Comments
 (0)