[libadwaita/wip/exalm/readme] Update readme
- From: Alexander Mikhaylenko <alexm src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [libadwaita/wip/exalm/readme] Update readme
- Date: Wed, 19 May 2021 07:58:17 +0000 (UTC)
commit 475e7204e140fa3cf57606cf0fe3d97e46b81eea
Author: Alexander Mikhaylenko <alexm gnome org>
Date: Wed May 19 12:55:39 2021 +0500
Update readme
* Remove badges - they are broken and can be added to gitlab description
instead
* Change the description from libhandy
* Fix capitalization
* Fix the steps for building docs
* Fix the steps for running the example
* Remove the mentions of the old Python example
Fixes https://gitlab.gnome.org/GNOME/libadwaita/-/issues/43
README.md | 18 ++++--------------
1 file changed, 4 insertions(+), 14 deletions(-)
---
diff --git a/README.md b/README.md
index 7e743eaf..8016394e 100644
--- a/README.md
+++ b/README.md
@@ -1,13 +1,10 @@
# Adwaita
-[![Pipeline
status](https://gitlab.gnome.org/GNOME/libadwaita/badges/main/build.svg)](https://gitlab.gnome.org/GNOME/libadwaita/commits/main)
-[![Code
coverage](https://gitlab.gnome.org/GNOME/libadwaita/badges/main/coverage.svg)](https://gitlab.gnome.org/GNOME/libadwaita/commits/main)
-The aim of the Adwaita library is to help with developing UI for mobile devices
-using GTK/GNOME.
+Building blocks for modern GNOME applications.
## License
-libadwaita is licensed under the LGPL-2.1+.
+Libadwaita is licensed under the LGPL-2.1+.
## Building
@@ -24,7 +21,7 @@ For build options see [meson_options.txt](./meson_options.txt). E.g. to enable d
```sh
meson . _build -Dgtk_doc=true
-ninja -C _build libadwaita-doc
+ninja -C _build
```
## Usage
@@ -32,14 +29,7 @@ ninja -C _build libadwaita-doc
There's a C example:
```sh
-_build/examples/example
-```
-
-and one in Python. When running from the built source tree it
-needs several environment variables so use \_build/run to set them:
-
-```sh
-_build/run examples/example.py
+_build/run _build/examples/adwaita-1-demo
```
## Documentation
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]