4 [![AGPL v3](https://img.shields.io/badge/license-AGPL%20v3-brightgreen.svg)](./LICENSE)
7 <!-- vim-markdown-toc GFM -->
9 * [What is Bytom?](#what-is-bytom)
10 * [Build from source](#build-from-source)
11 * [Requirements](#requirements)
12 * [Installation](#installation)
13 * [Get the source code](#get-the-source-code)
16 * [Create and launch a single node](#create-and-launch-a-single-node)
17 * [Issue an asset](#issue-an-asset)
18 * [Contributing](#contributing)
21 <!-- vim-markdown-toc -->
25 Bytom is software designed to operate and connect to highly scalable blockchain networks confirming to the Bytom Blockchain Protocol. Each network allows partipicants to define, issue and transfer digitial assets on a multi-asset shared ledger.
27 In the current state `bytom` is able to:
30 - Manage account as well as asset
36 - [Go](https://golang.org/doc/install) version 1.8 or higher, with `$GOPATH` set to your preferred directory
40 Ensure Go with the supported version is installed properly:
44 $ go env GOROOT GOPATH
47 #### Get the source code
50 $ git clone https://github.com/Bytom/bytom $GOPATH/src/github.com/bytom
58 $ cd $GOPATH/src/github.com/bytom
67 $ cd $GOPATH/src/github.com/bytom/cmd/bytomcli
73 ### Create and launch a single node
75 When successfully building the project, the `bytom` and `bytomcli` binary should be present in `cmd/bytom/bytom` and `cmd/bytomcli/bytomcli`, respectively. Then, initialize the node:
79 $ ./bytom init --home ./.bytom
82 After that, you'll `.bytom` generated in current directory. Launch the single node:
85 $ ./bytom node --home ./.bytom
92 $ ./bytomcli <command> <opt...>
97 Thank you for considering to help out with the source code! Any contributions are highly appreciated, and we are grateful for even the smallest of fixes!
99 If you run into an issue, feel free to [file one](https://github.com/Bytom/bytom/issues/) in this repository. We are glad to help!