From 62001ca96be34c3864406b438fdced7c95948b48 Mon Sep 17 00:00:00 2001 From: wallrony Date: Fri, 6 May 2022 11:25:15 -0300 Subject: [PATCH] Update README.md about running in mac M1 (#125) --- README.md | 21 +++++++++++++++++---- 1 file changed, 17 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 9190e9c..ea85f3b 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -![Comply](https://github.com/strongdm/comply/blob/master/logo.png) +![Comply](./logo.png) Comply is a SOC2-focused compliance automation tool: @@ -41,17 +41,20 @@ Join us in [Comply Users](https://join.slack.com/t/comply-users/shared_invite/zt [Demo video](https://vimeo.com/270257486) ## Start a Project + ![screencast 1](sc-1.gif) ## Build PDFs + ![screencast 4](sc-4.gif) ![pdf example](pdf-example.png) - ## Track Policy Coverage + ![screencast 3](sc-2.gif) ## Dashboard + ![screencast 2](sc-3.gif) ## Dependencies @@ -99,8 +102,18 @@ Serving content of output/ at http://127.0.0.1:4000 (ctrl-c to quit) For Windows users, replace $PWD with the full path to your project directory +### Running in macOS M1 + +If you're running Comply inside Docker or using Comply installed by HomeBrew in a macOS M1, you should increase you Docker memory usage to at least 7 GB or more, but it'll run a bit laggy. So, we recommend to run Comply locally with pandoc binary installed via HomeBrew. For that, install the `pandoc` and `basictex` packages using the following command: + +```bash +brew install pandoc basictex +``` + +Then when running the Comply binary installed by HomeBrew will work as expected. ## Ticketing Integrations: + - Jira - Github - Gitlab @@ -133,12 +146,12 @@ When comply creates a ticket (through `proc`, for instance), it sets the followi - reporter - summary -Please make sure that the default *Create Screen* has all of those fields enabled. Additionally, make sure that there are no other required fields for the issue type you choose. +Please make sure that the default _Create Screen_ has all of those fields enabled. Additionally, make sure that there are no other required fields for the issue type you choose. About authentication, you need to create an [API Token](https://id.atlassian.com/manage-profile/security/api-tokens) to use as a password. - ## Forking and local development + > Assumes installation of golang and configuration of GOPATH in .bash_profile, .zshrc, etc > Inspiration: http://code.openark.org/blog/development/forking-golang-repositories-on-github-and-managing-the-import-path