README.md

   1 Bytom
   2 =====
   3
   4 [![AGPL v3](https://img.shields.io/badge/license-AGPL%20v3-brightgreen.svg)](./LICENSE)
   5
   6 Table of Contents
   7 <!-- vim-markdown-toc GFM -->
   8
   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)
  14     * [Build](#build)
  15 * [Example](#example)
  16   * [Create and launch a single node](#create-and-launch-a-single-node)
  17   * [Issue an asset](#issue-an-asset)
  18 * [Contributing](#contributing)
  19 * [License](#license)
  20
  21 <!-- vim-markdown-toc -->
  22
  23 ## What is Bytom?
  24
  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.
  26
  27 In the current state `bytom` is able to:
  28
  29 - Issue assets
  30 - Manage account as well as asset
  31
  32 ## Build from source
  33
  34 ### Requirements
  35
  36 - [Go](https://golang.org/doc/install) version 1.8 or higher, with `$GOPATH` set to your preferred directory
  37
  38 ### Installation
  39
  40 Ensure Go with the supported version is installed properly:
  41
  42 ```bash
  43 $ go version
  44 $ go env GOROOT GOPATH
  45 ```
  46
  47 #### Get the source code
  48
  49 ``` bash
  50 $ git clone https://github.com/Bytom/bytom $GOPATH/src/github.com/bytom
  51 ```
  52
  53 #### Build
  54
  55 - Bytom
  56
  57 ``` bash
  58 $ cd $GOPATH/src/github.com/bytom
  59 $ make install
  60 $ cd ./cmd/bytom
  61 $ go build
  62 ```
  63
  64 - Bytomcli
  65
  66 ```go
  67 $ cd $GOPATH/src/github.com/bytom/cmd/bytomcli
  68 $ go build
  69 ```
  70
  71 ## Example
  72
  73 ### Create and launch a single node
  74
  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:
  76
  77 ```bash
  78 $ cd ./cmd/bytom
  79 $ ./bytom init --home ./.bytom
  80 ```
  81
  82 After that, you'll `.bytom` generated in current directory. Launch the single node:
  83
  84 ``` bash
  85 $ ./bytom node --home ./.bytom
  86 ```
  87
  88 ### Issue an asset
  89
  90 ```bash
  91 $ cd ./cmd/bytomcli
  92 $ ./bytomcli <command> <opt...>
  93 ```
  94
  95 ## Contributing
  96
  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!
  98
  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!
 100
 101 ## License
 102
 103 [AGPL v3](./LICENSE)