Skip to content

Commit

Permalink
README: Add 'Getting started' directions
Browse files Browse the repository at this point in the history
Based on flatpak#29, but a bit expanded and hopefully addressing concerns on that PR. Omits docs instructions for now as I'm not familiar with how that works.
  • Loading branch information
cassidyjames authored and GeorgesStavracas committed Nov 21, 2021
1 parent e60880d commit 4c210e3
Showing 1 changed file with 48 additions and 0 deletions.
48 changes: 48 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,51 @@ libportal - Flatpak portal library
==================================

libportal provides GIO-style async APIs for most Flatpak portals.

## Getting started

### The Meson build system

`libportal` uses Meson to build its projects. To install Meson on your system, follow the [Getting Meson instructions](https://mesonbuild.com/Getting-meson.html). If your system is missing a dependency, Meson will tell you which one. How you install your missing dependencies is up to you.

### Build libportal

The first time you build libportal, give `meson` a directory to build into; we recommend `_build`:

```
meson _build
```

Then use `ninja` to build the project, pointing it to your build directory:

```
ninja -C _build
```

For subsequent builds, you only need to use the `ninja -C _build` command.

### Build and run portal-test

If this is your first time building libportal, configure the project to include portal-test:

```
meson _build -Dbuild-portal-test=true
```

Otherwise, re-configure the project:

```
meson configure _build -Dbuild-portal-test=true
```

Then build:

```
ninja -C _build
```

And run the binary:

```
./_build/portal-test/portal-test
```

0 comments on commit 4c210e3

Please sign in to comment.