From 92f3105ac839776d4948379b49ab7042082ba3f8 Mon Sep 17 00:00:00 2001 From: Morgan McMillian Date: Wed, 8 Sep 2021 06:59:16 -0700 Subject: [PATCH] updated README and About for release --- .gitignore | 2 ++ AboutPage.qml.in | 2 +- README.md | 43 ++++++++++++++++++------------------------- 3 files changed, 21 insertions(+), 26 deletions(-) diff --git a/.gitignore b/.gitignore index 07e6538..00afd8c 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,5 @@ build/ pantalaimon-arm64 pantalaimon-armhf +panctl-arm64 +panctl-armhf diff --git a/AboutPage.qml.in b/AboutPage.qml.in index d709fcf..2ad1763 100644 --- a/AboutPage.qml.in +++ b/AboutPage.qml.in @@ -94,7 +94,7 @@ Page { Label { width: parent.width horizontalAlignment: Text.AlignHCenter - text: i18n.tr("Pantalaimon v0.9.2") + text: i18n.tr("Pantalaimon v0.10.3") wrapMode: Text.WordWrap fontSize: "large" } diff --git a/README.md b/README.md index 6a2a27a..757cdd9 100644 --- a/README.md +++ b/README.md @@ -13,47 +13,40 @@ End-to-end encryption aware Matrix reverse proxy daemon for Ubuntu Touch. - [x] App icon - [x] Fix image fetching (fixed in fluffychat) - [x] Cross compile python+pantalaimon -- [ ] Import/export keys -- [ ] Ability to verify, ignore, or blacklist devices -- [ ] Release on open-store.io +- [-] Import/export keys +- [-] Ability to verify, ignore, or blacklist devices ## Known Issues -* Previously encrypted messages cannot be decrypted -* No user interaction to verify, ignore, or blacklist devices +- Previously encrypted messages may not be decrypted -## Build requirements +## panctl -* [clickable](https://clickable-ut.dev/en/latest/install.html) -* qemu-user-static +The ability to verify, ignore, or blacklist devices is currently limited to the use of the panctl utility which can be accessed using the Terminal app by running `/opt/click.ubuntu.com/pantalaimon.thrrgilag/current/panctl`. See the [man](https://github.com/matrix-org/pantalaimon/blob/master/docs/man/panctl.md) for details on how to use it. -## Build for armhf +## Build pantalaimon and panctl -```sh -git clone https://git.sr.ht/~thrrgilag/pantalaimon-ut -git submodule update --init -clickable build-libs --arch armhf -clickable --arch armhf -``` +The background daemon (pantalaimon) and shell utility (panctl) are built directly on device due to complications with cross compiling dependencies. You'll need a device with sufficient space free on the system partition to install all of the required packages. For the most recent release I utilized a Raspberry Pi 4 to create the binaries for arm64 and armhf. -## Build for arm64 +1. Put the dev-build.sh script in /home/phablet on the target device and execute `./dev-build.sh` +2. Pull the ~/pantalaimon-build/dist/pantalaimon and ~/pantalaimon-build/dist/panctl to your local source tree +3. Rename the files to add -{ARCH} *(e.g. mv pantalaimon pantalaimon-arm64)* -```sh -git clone https://git.sr.ht/~thrrgilag/pantalaimon-ut -git submodule update --init -clickable build-libs --arch arm64 -clickable --arch arm64 -``` +## Build click package + +- Install or update [clickable](https://clickable-ut.dev/en/latest/install.html) +- For ARM64 devices run `clickable --arch=arm64` +- For ARMHF devices run `clickable --arch=armhf` ## Contributing -Send patches to -[~thrrgilag/pantalaimon-ut@lists.sr.ht](https://lists.sr.ht/~thrrgilag/pantalaimon-ut) +Report bugs or send patches to +[~thrrgilag/pantalaimon-ut@lists.sr.ht](https://lists.sr.ht/~thrrgilag/pantalaimon-ut). A tutorial for git send-email can be found at [git-send-email.io](https://git-send-email.io/) if you're not familiar with this method. -Bugs can be filed at https://todo.sr.ht/~thrrgilag/pantalaimon-ut +You can also join my public chat room at [#dev:thrrgilag.ems.host](https://matrix.to/#/#dev:thrrgilag.ems.host) or [dev@conference.dreamfall.space](xmpp:dev@conference.dreamfall.space?join). ## License