Commit 2a9df9e5 authored by Felix Pojtinger's avatar Felix Pojtinger Committed by Guido Gunther
Browse files

docs: Format README to enable syntax highlighting

This also adds code fences and blanks around headers.
parent ec70b4d8
Pipeline #1157 passed with stage
in 2 minutes and 9 seconds
......@@ -13,35 +13,48 @@ libhandy is licensed under the LGPL-2.1+.
To build libhandy you need the following build-deps:
sudo apt-get -y install gtk-doc-tools libgirepository1.0-dev libgnome-desktop-3-dev libgtk-3-dev meson pkg-config valac
```sh
sudo apt-get -y install gtk-doc-tools libgirepository1.0-dev libgnome-desktop-3-dev libgtk-3-dev meson pkg-config valac
```
## Building
We use the meson (and thereby Ninja) build system for libhandy. The quickest
We use the meson (and thereby Ninja) build system for libhandy. The quickest
way to get going is to do the following:
meson . _build
ninja -C _build
ninja -C _build install
```sh
meson . _build
ninja -C _build
ninja -C _build install
```
For build options see [meson_options.txt](./meson_options.txt). E.g. to enable documentation:
meson . _build -Dgtk_doc=true
ninja -C _build/ libhandy-doc
```sh
meson . _build -Dgtk_doc=true
ninja -C _build/ libhandy-doc
```
## Usage
There's a C example:
_build/examples/example
```sh
_build/examples/example
```
and one in Python. When running from the built source tree it
needs several environment varibles so use \_build/run to set them:
_build/run examples/example.py
```sh
_build/run examples/example.py
```
### Glade
To be able to use Handy's widgets in the glade interface designer without
installing the library use:
_build/run glade
```sh
_build/run glade
```
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment