simplify README content, 1st pass (#1151)

* simplify README content, 1st pass, re #1148 * Apply suggestions from code review * fix ident Co-authored-by: laizy <[email protected]>
ontio · Feb 20, 2020 · c1ed6fa · c1ed6fa
1 parent 9747ea3
commit c1ed6fa
Showing 1 changed file with 29 additions and 85 deletions.
diff --git a/README.md b/README.md
@@ -17,23 +17,6 @@ As a public blockchain project, Ontology is currently maintained by both the Ont
 
 New features are still being rapidly developed, therefore the master branch may be unstable. Stable versions can be found in the [releases section](https://github.com/ontio/ontology/releases).
 
-- [Features](#features)
-- [Build Development Environment](#build-development-environment)
-- [Download Ontology](#download-ontology)
-    - [Download Release](#download-release)
-    - [Build from Source Code](#build-from-source-code)
-- [Run Ontology](#run-ontology)
-    - [MainNet Sync Node](#mainnet-sync-node)
-    - [TestNet Sync Node](#testnet-sync-node)
-    - [Local PrivateNet](#local-privatenet)
-    - [Run with Docker](#run-in-docker)
-- [Examples](#examples)
-    - [ONT transfer sample](#ont-transfer-sample)
-    - [Query transfer status sample](#query-transfer-status-sample)
-    - [Query account balance sample](#query-account-balance-sample)
-- [Contributions](#contributions)
-- [License](#license)
-
 ## Features
 
 - Scalable lightweight universal smart contracts
@@ -46,22 +29,23 @@ New features are still being rapidly developed, therefore the master branch may
 - Quick block generation time (1-30 seconds)
 
 
-## Build Development Environment
-The requirements to build Ontology are:
+## Install from Binaries
+You can download a stable compiled version of the Ontology node software by either:
+
+- Downloading the latest Ontology binary file with `curl https://dev.ont.io/ontology_install | sh`.
+- Downloading a specific version from the [release section](https://github.com/ontio/ontology/releases).
+
+## Build From Source
+
+### Prerequisites
 
 - [Golang](https://golang.org/doc/install) version 1.11 or later
 - [Glide](https://glide.sh) (a third party package management tool for Golang)
 
-## Download Ontology
 
-### Download Release
-You can download a stable compiled version of the Ontology node software by either:
-
-- Downloading the latest Ontology binary file with `curl https://dev.ont.io/ontology_install | sh`.
-- Downloading a specific version from the [release section](https://github.com/ontio/ontology/releases).
+### Build
 
-### Build from Source Code
-Alternatively, you can build the Ontology application directly from the source code. Note that the code in the `master` branch may not be stable.
+Note that the code in the `master` branch may not be stable.
 
 1) Clone the Ontology repository into the appropriate `$GOPATH/src/github.com/ontio` directory:
 
@@ -76,21 +60,10 @@ $ go get github.com/ontio/ontology
 2) Fetch the dependent third party packages with [Glide](https://glide.sh):
 
 ```
-$ cd $GOPATH/src/github.com/ontio/ontology
-$ glide install
-```
-
-3) If necessary, update the dependent third party packages with Glide:
-
-```
-$ cd $GOPATH/src/github.com/ontio/ontology
-$ glide update
-```
-
-4) Build the source code with make:
-
-```
-$ make all
+cd $GOPATH/src/github.com/ontio/ontology
+glide install
+glide update
+make all
 ```
 
 After building the source code successfully, you should see two executable programs:
@@ -106,41 +79,21 @@ The Ontology CLI can run nodes for the MainNet, TestNet and local PrivateNet. Ch
 
 You can run an Ontology MainNet node built from the source code with:
 
- ``` shell
-./ontology
- ```
-
- To run it with a macOS release build:
-
- ``` shell
- ./ontology-darwin-amd64
- ```
-
- To run it with a Windows release build:
-
- ``` shell
- start ontology-windows-amd64.exe
- ```
+```shell
+./ontology                          # Linux
+./ontology-darwin-amd64             # MacOS
+start ontology-windows-amd64.exe    # Windows
+```
 
 ### TestNet Sync Node
 
 You can run an Ontology TestNet node built from the source code with:
 
- ``` shell
-./ontology --networkid 2
- ```
-
- To run it with a macOS release build:
-
- ``` shell
- ./ontology-darwin-amd64 --networkid 2
- ```
-
- To run it with a Windows release build:
-
- ``` shell
- start ontology-windows-amd64.exe --networkid 2
- ```
+```shell
+./ontology --networkid 2                        # Linux
+./ontology-darwin-amd64 --networkid 2           # MacOS
+ start ontology-windows-amd64.exe --networkid 2 # Windows
+```
 
 ### Local PrivateNet
 
@@ -152,8 +105,10 @@ The Ontology CLI allows you to run a local PrivateNet on your computer. Before y
 
 To start the PrivateNet built from the source code with:
 
-``` shell
-./ontology --testmode
+```shell
+./ontology --testmode                       # Linux
+./ontology-darwin-amd64 --testmode          # MacOS
+start ontology-windows-amd64.exe --testmode # Windows
 ```
 
 Here's an example of the directory structure
@@ -165,17 +120,6 @@ $ tree
     └── wallet.dat
 ```
 
-To run it with a macOS release build:
-
-``` shell
-./ontology-darwin-amd64 --testmode
-```
-
-To run it with a Windows release build:
-
-``` shell
-start ontology-windows-amd64.exe --testmode
-```
 
 ### Run with Docker