Skip to content

Commit c1ed6fa

Browse files
Lazaridislaizy
Lazaridis
andauthored
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]>
1 parent 9747ea3 commit c1ed6fa

File tree

1 file changed

+29
-85
lines changed

1 file changed

+29
-85
lines changed

README.md

Lines changed: 29 additions & 85 deletions
Original file line numberDiff line numberDiff line change
@@ -17,23 +17,6 @@ As a public blockchain project, Ontology is currently maintained by both the Ont
1717

1818
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).
1919

20-
- [Features](#features)
21-
- [Build Development Environment](#build-development-environment)
22-
- [Download Ontology](#download-ontology)
23-
- [Download Release](#download-release)
24-
- [Build from Source Code](#build-from-source-code)
25-
- [Run Ontology](#run-ontology)
26-
- [MainNet Sync Node](#mainnet-sync-node)
27-
- [TestNet Sync Node](#testnet-sync-node)
28-
- [Local PrivateNet](#local-privatenet)
29-
- [Run with Docker](#run-in-docker)
30-
- [Examples](#examples)
31-
- [ONT transfer sample](#ont-transfer-sample)
32-
- [Query transfer status sample](#query-transfer-status-sample)
33-
- [Query account balance sample](#query-account-balance-sample)
34-
- [Contributions](#contributions)
35-
- [License](#license)
36-
3720
## Features
3821

3922
- Scalable lightweight universal smart contracts
@@ -46,22 +29,23 @@ New features are still being rapidly developed, therefore the master branch may
4629
- Quick block generation time (1-30 seconds)
4730

4831

49-
## Build Development Environment
50-
The requirements to build Ontology are:
32+
## Install from Binaries
33+
You can download a stable compiled version of the Ontology node software by either:
34+
35+
- Downloading the latest Ontology binary file with `curl https://dev.ont.io/ontology_install | sh`.
36+
- Downloading a specific version from the [release section](https://github.com/ontio/ontology/releases).
37+
38+
## Build From Source
39+
40+
### Prerequisites
5141

5242
- [Golang](https://golang.org/doc/install) version 1.11 or later
5343
- [Glide](https://glide.sh) (a third party package management tool for Golang)
5444

55-
## Download Ontology
5645

57-
### Download Release
58-
You can download a stable compiled version of the Ontology node software by either:
59-
60-
- Downloading the latest Ontology binary file with `curl https://dev.ont.io/ontology_install | sh`.
61-
- Downloading a specific version from the [release section](https://github.com/ontio/ontology/releases).
46+
### Build
6247

63-
### Build from Source Code
64-
Alternatively, you can build the Ontology application directly from the source code. Note that the code in the `master` branch may not be stable.
48+
Note that the code in the `master` branch may not be stable.
6549

6650
1) Clone the Ontology repository into the appropriate `$GOPATH/src/github.com/ontio` directory:
6751

@@ -76,21 +60,10 @@ $ go get github.com/ontio/ontology
7660
2) Fetch the dependent third party packages with [Glide](https://glide.sh):
7761

7862
```
79-
$ cd $GOPATH/src/github.com/ontio/ontology
80-
$ glide install
81-
```
82-
83-
3) If necessary, update the dependent third party packages with Glide:
84-
85-
```
86-
$ cd $GOPATH/src/github.com/ontio/ontology
87-
$ glide update
88-
```
89-
90-
4) Build the source code with make:
91-
92-
```
93-
$ make all
63+
cd $GOPATH/src/github.com/ontio/ontology
64+
glide install
65+
glide update
66+
make all
9467
```
9568

9669
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
10679

10780
You can run an Ontology MainNet node built from the source code with:
10881

109-
``` shell
110-
./ontology
111-
```
112-
113-
To run it with a macOS release build:
114-
115-
``` shell
116-
./ontology-darwin-amd64
117-
```
118-
119-
To run it with a Windows release build:
120-
121-
``` shell
122-
start ontology-windows-amd64.exe
123-
```
82+
```shell
83+
./ontology # Linux
84+
./ontology-darwin-amd64 # MacOS
85+
start ontology-windows-amd64.exe # Windows
86+
```
12487

12588
### TestNet Sync Node
12689

12790
You can run an Ontology TestNet node built from the source code with:
12891

129-
``` shell
130-
./ontology --networkid 2
131-
```
132-
133-
To run it with a macOS release build:
134-
135-
``` shell
136-
./ontology-darwin-amd64 --networkid 2
137-
```
138-
139-
To run it with a Windows release build:
140-
141-
``` shell
142-
start ontology-windows-amd64.exe --networkid 2
143-
```
92+
```shell
93+
./ontology --networkid 2 # Linux
94+
./ontology-darwin-amd64 --networkid 2 # MacOS
95+
start ontology-windows-amd64.exe --networkid 2 # Windows
96+
```
14497

14598
### Local PrivateNet
14699

@@ -152,8 +105,10 @@ The Ontology CLI allows you to run a local PrivateNet on your computer. Before y
152105

153106
To start the PrivateNet built from the source code with:
154107

155-
``` shell
156-
./ontology --testmode
108+
```shell
109+
./ontology --testmode # Linux
110+
./ontology-darwin-amd64 --testmode # MacOS
111+
start ontology-windows-amd64.exe --testmode # Windows
157112
```
158113

159114
Here's an example of the directory structure
@@ -165,17 +120,6 @@ $ tree
165120
└── wallet.dat
166121
```
167122

168-
To run it with a macOS release build:
169-
170-
``` shell
171-
./ontology-darwin-amd64 --testmode
172-
```
173-
174-
To run it with a Windows release build:
175-
176-
``` shell
177-
start ontology-windows-amd64.exe --testmode
178-
```
179123

180124
### Run with Docker
181125

0 commit comments

Comments
 (0)