Skip to content

Commit

Permalink
Merge pull request #15 from blinklabs-io/chore/docs-readme-building-dev
Browse files Browse the repository at this point in the history
chore(docs): add readme section for building/running
  • Loading branch information
wolf31o2 authored Aug 31, 2023
2 parents d65dfa8 + ccc71c0 commit b13ea5f
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,19 @@ __NOTE__: This miner is still a work in progress and may not be functional
We're looking for people to join this project and help get it off the ground.

Discussion is on Discord at https://discord.gg/5fPRZnX4qW

# Development / Building

This requires Go 1.19 or better is installed. You also need `make`.

```bash
# Build
make
# Run
./bluefin
```

You can also run the code without building a binary, first
```bash
go run .
```

0 comments on commit b13ea5f

Please sign in to comment.