Skip to content
Snippets Groups Projects
README.md 1.07 KiB
Newer Older
Hans Moog's avatar
Hans Moog committed
# goshimmer
capossele's avatar
capossele committed

## Run Shimmer

First, you need to [install Go](https://golang.org/doc/install) if it is not already installed on your machine. It is recommended that you use the most recent version of Go.

### Requirements

- gcc: Some packages in this repo might require to be compile by gcc. Windows users can install [MinGW-gcc](http://tdm-gcc.tdragon.net/download). 

## Build

If you need to develop locally and be able to build by using your local code, i.e., without waiting for pushing your commits on the repo, clone the repository directly inside the `src` folder of your `$GOPATH` with the command:

```
git clone git@github.com:iotaledger/goshimmer.git
```

or if you prefer https over ssh

```
git clone https://github.com/iotaledger/goshimmer.git
```

To download and install all the package dependencies just run:
```
go get github.com/iotaledger/goshimmer
```

You can build your executable (as well as cross compiling for other architectures) by running the `go build` tool inside the just cloned folder `goshimmer`:

```
go build -o shimmer
```
You can then run by:

```
./shimmer
```