Skip to content

Latest commit

 

History

History
43 lines (34 loc) · 1.71 KB

README.md

File metadata and controls

43 lines (34 loc) · 1.71 KB
Raw

Go Quai

The reference implementation of the Quai protocol, written in Go.

API Reference Go Report Card Discord

Usage

Building from source

Once you have the necessary prerequisites, clone the go-quai repository and navigate to it using:

git clone https://github.com/dominant-strategies/go-quai.git
cd go-quai
make go-quai

Running a node

To run a node with default options, simply execute:

make run

There are several options and subcommands available when running the go-quai client. See the help menu for a complete list:

./build/go-quai --help

Any options may be provided as command-line arguments or specified in the config file at config.yaml.

Running tests

To run the included unit tests, run the following command:

./build/go-quai test

Contributing

We welcome community contributions! If you find a bug, have a feature request, or would like to help out with development, we would love to hear from you; no fix is too small. Please take a look at [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines for contributing to the project.

License

This software is licensed under the GNU Genreral Public License, Version 3. See LICENSE for details.