README.md

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