Skip to content

Commit

Permalink
Update Readme.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
pakal committed Feb 27, 2023
1 parent 94890d1 commit f26b860
Showing 1 changed file with 13 additions and 6 deletions.
19 changes: 13 additions & 6 deletions Readme.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
Witness Angel Authenticator
##################################

Application homepage: https://witnessangel.com/en/authenticator-application/
Presentation
===============================

This cross-platform app allows trusted third parties of the Witness Angel ecosystem, called "Key Guardians",
to create and edit their "authenticators" (digital identities and secure keychains).
Expand All @@ -10,9 +11,11 @@ These digital identities can be published to a web registry, so that Witness Ang

More generally, this app can be used for any workflow where sensitive data must be protected by remote individuals, especially in "shared secret" encryption schemes.

Application homepage with download links: https://witnessangel.com/en/authenticator-application/

Getting started
==================

Getting started with development
=======================================

Instead of pip, we use `poetry <https://github.com/sdispater/poetry>`_ to install dependencies.

Expand All @@ -30,23 +33,27 @@ Or if you're already inside the proper python virtualenv (e.g. in a `poetry shel

To only launch the recorder service, not the GUI application, end this command with "main.py --service" (the GUI itself relaunches the recorder service if it's not active).

To generate an executable version of the program::
To generate an executable version of the program for Windows/MacOs/Linux::

$ pip install -U pyinstaller
$ python -m PyInstaller pyinstaller.spec

Note that arguments like "--windowed --onefile" are overridden by the content of the spec file

To build a debug APK and deploy it via USB on an android device (only works on Linux)::
On MacOS, setting MACOS_CODESIGN_IDENTITY environment variable is necessary

To build a debug APK and deploy it via USB on an Android device (only works under Linux host)::

Create local symlinks "wacryptolib/" and "wacomponents/", pointing to "src/" folders of these Git repositories.
Create local symlinks "wacryptolib/" and "wacomponents/", pointing to the "src/" folders of these Git repositories.

Install "buildozer" with pip.

And then do:

$ buildozer android debug deploy run logcat

To create an iOS release, it's more complicated (buildozer failed so far), see https://kivy.org/doc/stable/guide/packaging-ios.html

To force the startup language of the GUI application, set the "LANG" environment variable to "fr" or "en".


0 comments on commit f26b860

Please sign in to comment.