From 6c7926dbcffa047512c4c3e8d89754986e93de1e Mon Sep 17 00:00:00 2001 From: Sarah Jamie Lewis Date: Wed, 13 Feb 2019 20:38:29 +0000 Subject: [PATCH] Update 'README.md' --- README.md | 22 ++++++++++++++++++---- 1 file changed, 18 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 5333dae..8e83171 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,26 @@ -# Setup +# Cwtch - UI -## Android +This codebase provides a graphical user interface for Desktop and Android for [Cwtch: Privacy Preserving Infrastructure for Asynchronous, Decentralized and Metadata Resistant Applications](https://git.openprivacy.ca/cwtch.im/cwtch) -A arm-pie version of tor like [tor-0.3.4.8.arm-pie](https://git.openprivacy.ca/openprivacy/buildfiles/raw/master/tor/tor-0.3.4.8.arm-pie) is required to be placed in `android/libs/armeabi-v7a` with the name `libtor.so` +# Security -# Deployment +**Cwtch is an experimental concept and prototype. We do not recommend you use Cwtch today if you require secure communication.** At least, not yet. + + If you discover a security issue, please log an issue above, or email team@cwtch.im. + +# Compiling & Running +This code relies on [therecipe/qt](https://github.com/therecipe/qt) before getting started consult the [Installation](https://github.com/therecipe/qt/wiki/Installation) and [Getting Started](https://github.com/therecipe/qt/wiki/Getting-Started) documentation to get that up and running. It will make building this much easier. + +## Desktop + qtdeploy build desktop + ./deploy/linux/ui.sh -local -debug 2>&1 | grep -v 'Detected anchors on an item that is managed by a layout.' + + +The -local and -debug flags are helpful when developing. ## Android +A arm-pie version of tor like [tor-0.3.4.8.arm-pie](https://git.openprivacy.ca/openprivacy/buildfiles/raw/master/tor/tor-0.3.4.8.arm-pie) is required to be placed in `android/libs/armeabi-v7a` with the name `libtor.so` + qtdeploy -docker build android adb install deploy/android/build-debug.apk