diff --git a/README.md b/README.md index 82ea628f19..3f2bfde5a2 100644 --- a/README.md +++ b/README.md @@ -97,7 +97,12 @@ Read [this](https://github.com/golang/go/wiki/Modules#how-to-install-and-activat ### Setting Up Local Dev Environment -Building is supported on OS X, Linux, FreeBSD, and Windows. +Building is supported on: +- Linux, GLIBC 2.34+ is required +- MacOS 13 (Intel) and MacOS 14 (Arm) and newer +- Windows 10 and newer + +FreeBSD is not officially supported. Install [Go 1.22 or later](https://golang.org/dl/) for your platform, if you haven't already. @@ -112,6 +117,24 @@ Before building we need to set up the golang environment. Do this by running: make install ``` +Make sure the environment is set up correctly: + +```bash +make go-env-test +``` + +**CGO_CFLAGS** must be set to "-I/go-spacemesh/build/ -DSQLITE_ENABLE_DBSTAT_VTAB=1" +**CGO_LDFLAGS** must be set to "-L/go-spacemesh/build/ -Wl,-rpath,$ORIGIN -Wl,-rpath,/go-spacemesh/build/" + +Make sure you have **OpenCL** library installed + +To check if setup was configured successfully, try to run: +```bash +make test +``` + +There shouldn't be any build errors, but please note that running the tests will take some time. + ### How to run standalone node? After you got a binary standalone fully functional network can be launched