Skip to content

Commit a2a11d1

Browse files
authored
Merge pull request #4045 from nspcc-dev/tune-readme
Tune readme
2 parents 82f975e + 9db7473 commit a2a11d1

File tree

1 file changed

+14
-10
lines changed

1 file changed

+14
-10
lines changed

README.md

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -33,10 +33,8 @@ This includes, but not limited to (see documentation for more details):
3333
- [Oracle service](docs/oracle.md)
3434
- [State validation service](docs/stateroots.md)
3535

36-
The protocol implemented here is Neo N3-compatible, however you can also find
37-
an implementation of the Neo Legacy protocol in the [**master-2.x**
38-
branch](https://github.com/nspcc-dev/neo-go/tree/master-2.x) and releases
39-
before 0.80.0 (**0.7X.Y** track).
36+
The protocol implemented is compatible with the latest C# node releases, but
37+
has some experimental extensions as well.
4038

4139
# Getting started
4240

@@ -47,13 +45,13 @@ provided (but smart contract compiler requires Go compiler to operate). You
4745
can grab it from [releases
4846
page](https://github.com/nspcc-dev/neo-go/releases), use a Docker image (see
4947
[Docker Hub](https://hub.docker.com/r/nspccdev/neo-go) for various releases of
50-
NeoGo, `:latest` points to the latest release) or build yourself.
48+
NeoGo, `latest` points to the latest release) or build yourself.
5149

5250
### Building
5351

5452
Building NeoGo requires modern Go (any officially supported version, see
5553
[NeoSPCC Go policy](https://github.com/nspcc-dev/.github/blob/master/go.md)
56-
for how we manage Go updates) + and `make`:
54+
for how we manage Go updates) and `make`:
5755

5856
```
5957
make
@@ -100,6 +98,11 @@ Available network flags:
10098
- `--privnet, -p`
10199
- `--testnet, -t`
102100

101+
Or point NeoGo to a specific config with `--config-file` parameter like:
102+
```
103+
./bin/neo-go node --config-file ./config/protocol.mainnet.neofs.yml
104+
```
105+
103106
To run a consensus/committee node, refer to [consensus
104107
documentation](docs/consensus.md).
105108

@@ -119,11 +122,12 @@ protocol) and `20331` (JSON-RPC server).
119122

120123
### Importing mainnet/testnet dump files
121124

122-
If you want to jump-start your mainnet or testnet node with [chain archives
123-
provided by NGD](https://sync.ngd.network/), follow these instructions:
125+
If you want to jump-start your mainnet or testnet node with NEP-32 chain
126+
archives [provided by NGD](https://sync.ngd.network/)
127+
[or NeoSPCC](https://archive.fs.neo.org/), follow these instructions:
124128
```
125-
$ wget .../chain.acc.zip # chain dump file
126-
$ unzip chain.acc.zip
129+
$ wget .../chain.acc.zip # chain dump file (not needed for NeoSPCC archives)
130+
$ unzip chain.acc.zip # (not needed for NeoSPCC archives)
127131
$ ./bin/neo-go db restore -m -i chain.acc # for testnet use '-t' flag instead of '-m'
128132
```
129133

0 commit comments

Comments
 (0)