forked from cwtch.im/ui
Update 'README.md'
This commit is contained in:
parent
5bdfc856a0
commit
6c7926dbcf
22
README.md
22
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
|
## 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
|
qtdeploy -docker build android
|
||||||
adb install deploy/android/build-debug.apk
|
adb install deploy/android/build-debug.apk
|
||||||
|
|
Loading…
Reference in New Issue