From 409abba995e7add59ab8e0391dbe1f4132695fc0 Mon Sep 17 00:00:00 2001 From: Delong Lu Date: Wed, 15 Apr 2020 17:14:18 +0000 Subject: [PATCH] Update README.md --- BUILDS.md | 25 +++++++++++++------------ README.md | 20 ++++++++++---------- 2 files changed, 23 insertions(+), 22 deletions(-) diff --git a/BUILDS.md b/BUILDS.md index f48142aa..250fc60e 100644 --- a/BUILDS.md +++ b/BUILDS.md @@ -2,14 +2,14 @@ ## Prerequisites * Go 1.13 -* Bash with basic build utils: make, gcc, sed, find, grep, … +* Bash with basic build utils: make, gcc, sed, find, grep, ... * For Windows it is recommended to use MinGW 64bit shell from [MSYS2](https://www.msys2.org/) * GCC (linux, windows) or Xcode (macOS) * Windres (windows) To enable the sending of crash reports using Sentry please set the -`main.DSNSentry` value with client key of your sentry project before build. -Otherwise sending of crash reports will be disabled. +`main.DSNSentry` value with the client key of your sentry project before build. +Otherwise, the sending of crash reports will be disabled. ## Build * for Windows please unset the `MSYSTEM` variable @@ -25,14 +25,15 @@ make build ``` * The result will be stored in `./cmd/Destop-Bridge/deploy/${GOOS}/` - * for `linux` binary will the name of project directory e.g `bridge` - * for `windows` the binary has extension `.exe` e.g `bridge.exe` - * for `darwin` the application will be created with name of project directory e.g `bridge.app` + * for `linux`, the binary will have the name of the project directory (e.g `bridge`) + * for `windows`, the binary will have the file extension `.exe` (e.g `bridge.exe`) + * for `darwin`, the application will be created with name of the project directory (e.g `bridge.app`) -## Usefull tests, lints and checks -In order to be able to run following commands please install development dependencies: `make install-dev-dependencies` +## Useful tests, lints and checks +In order to be able to run following commands please install the development dependencies: +`make install-dev-dependencies` -* `make test` will run unit test for whole project -* `make lint` will run liter for whole project -* `make -C ./tests test` will run integration tests for Bridge application -* `make run` will compile without GUI and start Bridge application in CLI mode +* `make test` will run all unit tests +* `make lint` will lint the whole project +* `make -C ./tests test` will run the integration tests +* `make run` will build Bridge without a GUI and start it in CLI mode diff --git a/README.md b/README.md index 34a4517d..0cc61b12 100644 --- a/README.md +++ b/README.md @@ -7,25 +7,25 @@ For licensing information see [COPYING](./COPYING.md). For contribution policy see [CONTRIBUTING](./CONTRIBUTING.md). ## Description -ProtonMail Desktop Bridge for e-mail clients. +ProtonMail Bridge for e-mail clients. -When launched, the servers will be started and a GUI will show up. From this GUI, -the server can be started and stopped and configuration for e-mail clients can -be generated. +When launched, Bridge will initialize local IMAP/SMTP servers and render +its GUI. -To configure an e-mail client, enter your ProtonMail credentials. Open your -e-mail client and add a new account with the settings which are displayed. -The client will be able to sync with your ProtonMail account only when the -bridge is started, so enabling it on startup is recommended. +To configure an e-mail client, firstly log in using your ProtonMail credentials. +Open your e-mail client and add a new account using the settings which are +located in the Bridge GUI. The client will only be able to sync with +your ProtonMail account when the Bridge is running, thus the option +to start Bridge on startup is enabled by default. -When the main window is closed, the bridge will continue to run in the +When the main window is closed, Bridge will continue to run in the background. More details [on the public website](https://protonmail.com/bridge). ## Keychain -You need to have keychain in order to run the ProtonMail Bridge. On Mac or +You need to have a keychain in order to run the ProtonMail Bridge. On Mac or Windows, Bridge uses native credential managers. On Linux, use [Gnome keyring](https://wiki.gnome.org/Projects/GnomeKeyring/) or