Skip to content

Commit

Permalink
fix readme (#6068)
Browse files Browse the repository at this point in the history
## Motivation

Env variables some times are not set properly, which affects tests and building.
  • Loading branch information
ConvallariaMaj committed Jul 3, 2024
1 parent 9a01a6c commit 3c9a9be
Showing 1 changed file with 24 additions and 1 deletion.
25 changes: 24 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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<absolute_path_to_repo>/go-spacemesh/build/ -DSQLITE_ENABLE_DBSTAT_VTAB=1"
**CGO_LDFLAGS** must be set to "-L<absolute_path_to_repo>/go-spacemesh/build/ -Wl,-rpath,$ORIGIN -Wl,-rpath,<absolute_path_to_repo>/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
Expand Down

0 comments on commit 3c9a9be

Please sign in to comment.