TrueCloudLab/neo-go
8
0
Fork 0
mirror of https://github.com/nspcc-dev/neo-go.git synced 2024-11-26 19:42:23 +00:00
Code Issues Projects Releases Packages Wiki Activity

Merge pull request #842 from nspcc-dev/master-3.0-readme

Browse source 
README/docs: add 3.0 notice, update links to relative
This commit is contained in:
Roman Khimov 2020-04-10 10:34:24 +03:00 committed by GitHub
commit c5721266ae
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 16 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
README.md
View file

@ -16,14 +16,21 @@
# Overview # Overview
This project aims to be a full port of the original C# [NEO project](https://github.com/neo-project). This project aims to be a full port of the original C# [Neo project](https://github.com/neo-project).
A complete toolkit for the NEO blockchain, including: A complete toolkit for the NEO blockchain, including:
- [Consensus node](docs/consensus.md) - [Consensus node](docs/consensus.md)
- [RPC node & client](https://github.com/nspcc-dev/neo-go/tree/master/docs/rpc.md) - [RPC node & client](docs/rpc.md)
- [CLI tool](https://github.com/nspcc-dev/neo-go/blob/master/docs/cli.md) - [CLI tool](docs/cli.md)
- [Smart contract compiler](https://github.com/nspcc-dev/neo-go/blob/master/docs/compiler.md) - [Smart contract compiler](docs/compiler.md)
- [NEO virtual machine](https://github.com/nspcc-dev/neo-go/blob/master/docs/vm.md) - [NEO virtual machine](docs/vm.md)
This branch (**master**) is under active development now (read: won't work
out of the box) and aims to be compatible with Neo 3. For the current stable
version compatible with Neo 2 please refer to the [**master-2.x**
branch](https://github.com/nspcc-dev/neo-go/tree/master-2.x) and releases
before 0.80.0 (**0.7X.Y** track). Releases starting from 0.90.0 will contain
Neo 3 code.
# Getting started # Getting started
@ -101,7 +108,7 @@ where you can switch on/off and define port. Prometheus is enabled and Pprof is
# Contributing # Contributing
Feel free to contribute to this project after reading the Feel free to contribute to this project after reading the
[contributing guidelines](https://github.com/nspcc-dev/neo-go/blob/master/CONTRIBUTING.md). [contributing guidelines](CONTRIBUTING.md).
Before starting to work on a certain topic, create an new issue first, Before starting to work on a certain topic, create an new issue first,
describing the feature/topic you are going to implement. describing the feature/topic you are going to implement.
@ -114,4 +121,4 @@ describing the feature/topic you are going to implement.
# License # License
- Open-source [MIT](https://github.com/nspcc-dev/neo-go/blob/master/LICENSE.md) - Open-source [MIT](LICENSE.md)

2
docs/cli.md
View file

@ -166,7 +166,7 @@ INDEX OPCODE DESC
``` ```
In depth documentation about the **neo-go** compiler and smart contract examples can be found inside In depth documentation about the **neo-go** compiler and smart contract examples can be found inside
the [compiler package](https://github.com/nspcc-dev/neo-go/tree/master/pkg/compiler). the [compiler package](pkg/compiler).
## VM run ## VM run
To run VM use To run VM use

2
docs/compiler.md
View file

@ -138,7 +138,7 @@ At the moment this is implemented via RPC call to the remote server.
## Smart contract examples ## Smart contract examples
Some examples are provided in the [examples directory](https://github.com/nspcc-dev/neo-go/tree/master/examples). Some examples are provided in the [examples directory](examples).
### Check if the invoker of the contract is the owning address ### Check if the invoker of the contract is the owning address