2017-07-21 05:23:45 -07:00
|
|
|
# Quark
|
2017-01-26 13:48:54 -08:00
|
|
|
|
2017-07-21 05:23:45 -07:00
|
|
|
Quark is an [ABCI application](https://github.com/tendermint/abci) designed to
|
|
|
|
|
be used with the [Tendermint consensus engine](https://tendermint.com/) to form
|
|
|
|
|
a Proof-of-Stake cryptocurrency. It also provides a general purpose framework
|
|
|
|
|
for extending the feature-set of the cryptocurrency by implementing plugins.
|
2017-01-26 13:48:54 -08:00
|
|
|
|
2017-07-21 05:23:45 -07:00
|
|
|
Quark serves as a reference implementation for how we build ABCI applications
|
|
|
|
|
in Go, and is the framework in which we implement the [Cosmos
|
|
|
|
|
Hub](https://cosmos.network). **It's easy to use, and doesn't require any
|
|
|
|
|
forking** - just implement your plugin, import the quark libraries, and away
|
|
|
|
|
you go with a full-stack blockchain and command line tool for transacting.
|
2017-01-26 13:48:54 -08:00
|
|
|
|
2017-03-01 13:01:47 -08:00
|
|
|
## Prerequisites
|
|
|
|
|
|
2017-03-13 14:23:05 -07:00
|
|
|
[Install and setup Golang](https://tendermint.com/docs/guides/install-go).
|
2017-03-01 13:01:47 -08:00
|
|
|
|
2017-01-26 13:48:54 -08:00
|
|
|
## Installation
|
|
|
|
|
|
2017-02-10 13:40:20 -08:00
|
|
|
```
|
|
|
|
|
go get -u github.com/tendermint/basecoin/cmd/basecoin
|
|
|
|
|
```
|
|
|
|
|
|
2017-03-13 14:23:05 -07:00
|
|
|
See the [install guide](/docs/guide/install.md) for more details.
|
2017-02-10 13:40:20 -08:00
|
|
|
|
2017-01-29 12:48:28 -08:00
|
|
|
|
2017-03-13 14:23:05 -07:00
|
|
|
## Guide
|
2017-01-29 15:23:50 -08:00
|
|
|
|
2017-07-21 05:23:45 -07:00
|
|
|
1. Getting started with the [Quark basics](/docs/guide/basecoin-basics.md)
|
2017-04-26 21:54:56 -07:00
|
|
|
1. Learning to [use the plugin system](/docs/guide/basecoin-plugins.md)
|
2017-07-21 05:23:45 -07:00
|
|
|
1. More features of the [Quark tool](/docs/guide/basecoin-tool.md)
|
|
|
|
|
1. Learn how to use [Inter-Blockchain Communication (IBC)](/docs/guide/ibc.md)
|
2017-04-30 16:50:14 -07:00
|
|
|
1. See [more examples](github.com/tendermint/basecoin-examples)
|
2017-01-29 15:23:50 -08:00
|
|
|
|
|
|
|
|
|
2017-04-26 21:54:56 -07:00
|
|
|
To deploy a testnet, see our [repository of deployment tools](https://github.com/tendermint/tools).
|
