Silverfish/proton-bridge
1
0
Fork 1
mirror of https://github.com/ProtonMail/proton-bridge.git synced 2025-12-10 04:36:43 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Delong Lu
2020-04-15 17:14:18 +00:00
committed by Jakub Cuth
parent 3b1528cc2a
commit 409abba995
2 changed files with 23 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
BUILDS.md
View File

@ -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