Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Tarak Ben Youssef committed Apr 3, 2024
1 parent bc355b7 commit 2d81e61
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,11 @@ To start using the SDK, install Go 1.13 or above and run go get:
go get github.com/onflow/flow-go-sdk
```

Building and testing Go commands with the SDK require enabling cgo `CGO_ENABLED=1` because of the underlying
cryptography library. Refer to the [crypto repository build](https://github.com/onflow/crypto?tab=readme-ov-file#build) for more details.
Building and testing Go commands with the SDK require enabling cgo `CGO_ENABLED=1` because of the underlying cryptography library.
Refer to the [crypto repository build](https://github.com/onflow/crypto?tab=readme-ov-file#build) for more details.

Note that it is possible to build with cgo disabled `CGO_ENABLED=0`, but this requires confirming the choice by using the Go build tag `no-cgo`. This would disable the crypto BLS signature features of the SDK.
Any call of a BLS tool would result in a panic.

## Generating Keys

Expand Down

0 comments on commit 2d81e61

Please sign in to comment.