From 39986ba6b4cec35806efecaf59da7dcdc2214b3c Mon Sep 17 00:00:00 2001 From: Nico Alt <nicoalt@posteo.org> Date: Mon, 25 Mar 2019 15:07:19 +0100 Subject: [PATCH] Add more information to readme --- README.md | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c653c01..03913c9 100644 --- a/README.md +++ b/README.md @@ -5,9 +5,26 @@ It uses the [Briar REST API](https://code.briarproject.org/briar/briar/blob/master/briar-headless/README.md) and therefore requires Java. +## Installation + +So far, there is no official installation method and +you have to build it from source. + +## Developers + +The easiest and most convenient way is to build _briar-gtk_ using +[Builder](https://wiki.gnome.org/Apps/Builder). +In _Builder_, click "Clone Repository" at the bottom and +enter the URL to this Git project. + ## Design Goals -* Intuitive and simple UI, adaptive to different screen sizes (desktop and mobile devices) +* Intuitive UI that follows the Briar Android client +* Main platform is GNU/Linux, but should also support Windows and macOS +* Follows [GNOME Human Interface Guidelines](https://developer.gnome.org/hig/stable/) +* Adaptive to different screen sizes (desktop and mobile devices) +* Has [phone constraints](https://developer.puri.sm/Librem5/Apps/Guides/Design/Constraints.html) in mind +* Strictly separates API wrapper from GTK stuff, making former a solid base for other (commandline) clients ## License -- GitLab