Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
yveszoundi committed Jul 9, 2022
1 parent ea2acc0 commit d182669
Show file tree
Hide file tree
Showing 5 changed files with 11 additions and 16 deletions.
13 changes: 4 additions & 9 deletions README.org
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Below are some screenshots of the graphical Desktop client running on Mac OS.
- Pre-installed [[https://xebia.com/blog/podman-the-free-container-engine-alternative-to-docker/][container solution]], with no required user configuration ([[./entrusted_webserver][entrusted_webserver]])
- Extra isolation layer with a virtual machine
- The application supports multiple languages (English and French for now)
- On Mac OS, [[https://github.com/lima-vm/lima][Lima]] is supported as an alternative to [[https://www.docker.com/products/docker-desktop/][Docker]] (default /Lima/ instance)
- On Mac OS, [[https://github.com/lima-vm/lima][Lima]] is supported as an alternative to [[https://www.docker.com/products/docker-desktop/][Docker]] (/default Lima instance/ only)

* What is available?

Expand Down Expand Up @@ -85,13 +85,8 @@ Below is a high-level architecture overview, the solution relies on a container
* What is required?

- *Operating System*: Linux, Mac OS or Windows
- Mostly Linux has been tested
- BSD users can probably use the "Online service" from the Live CD ISO (via VirtualBox, etc.)
- *Container Runtime*: [[https://podman.io/][Podman]], [[https://www.docker.com/][Docker]] or [[https://github.com/lima-vm/lima][Lima]]
- On Linux, please install Podman or Docker
- On Mac OS, please use either Docker or Lima
- On Windows, Docker is recommended
- *Container Runtime*: [[https://podman.io/][Podman]] (Linux), [[https://www.docker.com/][Docker]] (Linux, Mac OS, Windows) or [[https://github.com/lima-vm/lima][Lima]] (Mac OS)

Conversions will fail if the container solution is not running or available in your [[https://www.java.com/en/download/help/path.html]["PATH settings"]]:
- The tool doesn't attempt to modify software on your machine (install or change other programs)
- The tool doesn't attempt to manage other software running on your machine (start/stop services)
- The tool doesn't attempt to modify software on your machine (install or change programs)
- The tool doesn't attempt to manage software on your machine (start or stop services)
4 changes: 2 additions & 2 deletions entrusted_client/README.org
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,8 @@ This is an application (command-line & desktop GUI), that converts /potentially

* What is required?

This application relies on common Rust tooling for builds and a container engine solution for execution:
- For execution, it is assumed that the [[../entrusted_container][entrusted_container]] component is deployed (under [[https://www.docker.com/][Docker]] or [[https://podman.io/][Podman]] or [[https://github.com/lima-vm/lima][Lima]])
- For compilation, you need a recent version of the Rust toolchain ([[https://www.rust-lang.org/tools/install][rustc]] compiler and [[https://doc.rust-lang.org/cargo/][cargo]]).
- For execution, it is assumed that the =entrusted-container= application is deployed under [[https://www.docker.com/][Docker]] or [[https://podman.io/][Podman]] or [[https://github.com/lima-vm/lima][Lima]].

* What does it look like?

Expand Down Expand Up @@ -99,6 +98,7 @@ The configuration format is [[https://toml.io/en/][TOML]], it's a bit similar to
# Only if the conversion is successful each document will be opened automatically
# "AcruBOT_ReadAZ" is the name of the PDF viewer as "identified" in the GUI client
# That name isn't just random: the name, spacing and case all matter...
# Only configure this manually if you know what you're doing
# preview-result-appname=AcruBOT_ReadAZ
#+end_src

Expand Down
10 changes: 5 additions & 5 deletions entrusted_webclient/README.org
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@

* What is this?

This repository provides a command-line client for the =entrusted-webserver= component. It also acts a concrete tutorial of the =entrusted-webserver= API usage.
This repository provides a command-line client for the =entrusted-webserver= component. It also provides a concrete usage of the =entrusted-webserver= API.

There are few reasons to run the =entrusted-webclient= binary:
- You opted to install the =entrusted-webserver= instead of the default clients (GUI or CLI)
- You do not want your Web browser to use more resources (Nowadays, most browsers require ~1GB of RAM just with few tabs open!)
- You opted to install the =entrusted-webserver= on a remote machine
- You do not have a Web browser installed on your local machine (i.e. old computer with limited resources)
- Occasionally you want to run automation scripts ([[https://unix.stackexchange.com/questions/12902/how-to-run-find-exec][find and exec]]).
- This can be use for recursive conversions
- This can supplement existing workflows driven from shell scripts
- This can be suitable for batch conversions
- This can supplement existing workflows driven from shell scripts or other programs

* How does it works?

Expand Down
Binary file modified images/ui-screenshot-convert.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/ui-screenshot-settings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit d182669

Please sign in to comment.