Skip to content

docs: Add readme #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jsparber merged 1 commit into from
Apr 8, 2026
Merged

docs: Add readme #3

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 32 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,32 @@
# p2panda-gobject
Introspectable GObject Bindings for p2panda
p2panda-gobject - Introspectable GLib/GObject Bindings for p2panda
=============================================================

p2panda-gobject provides a GLib/GObject introspectable API for [p2panda](https://p2panda.org). The library is called `libp2panda`. This project is still in **alpha** and doesn't give any API stability guarantee. This project used [GObject Introspection](https://gi.readthedocs.io/en/latest) to provide support for multiple langugages.

## Getting started

`p2panda-gobject` uses Meson. To install Meson on your system,
follow the [Getting Meson instructions](https://mesonbuild.com/Getting-meson.html).

### Build libp2panda
To build the project the following commands can be used:
```
meson setup _build --prefix=/usr
meson compile -C _build
```

### Install p2panda-gobject
To install `libp2panda` the following commands can be used:
```
meson install -C _build
```

### Build docs for libp2panda
To generate the docs the following commands can be used:
```
meson setup -Dcapi_docs=true --reconfigure
meson compile -C _build
```

### Use libp2panda in python
The tests contain a example on how to use libp2padna in python.
Loading