aarifullin/neoneo-go
1
0
Fork 0
forked from TrueCloudLab/neoneo-go
Code Pull requests Activity

README/docs: add 3.0 notice, update links to relative

Browse source 
Goreportcard doesn't support branching, sorry: https://github.com/gojp/goreportcard/issues/96
And Godoc too: https://github.com/golang/gddo/issues/593
This commit is contained in:
Roman Khimov 2020-04-09 19:45:46 +03:00
parent bfaa025a34
commit 1433c795c2
3 changed files with 18 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

27
README.md
View file

@ -7,23 +7,28 @@
<hr /> <hr />
[![codecov](https://codecov.io/gh/nspcc-dev/neo-go/branch/master/graph/badge.svg)](https://codecov.io/gh/nspcc-dev/neo-go) [![codecov](https://codecov.io/gh/nspcc-dev/neo-go/branch/master-2.x/graph/badge.svg)](https://codecov.io/gh/nspcc-dev/neo-go/branch/master-2.x)
[![CircleCI](https://circleci.com/gh/nspcc-dev/neo-go/tree/master.svg?style=svg)](https://circleci.com/gh/nspcc-dev/neo-go/tree/master) [![CircleCI](https://circleci.com/gh/nspcc-dev/neo-go/tree/master-2.x.svg?style=svg)](https://circleci.com/gh/nspcc-dev/neo-go/tree/master-2.x)
[![Report](https://goreportcard.com/badge/github.com/nspcc-dev/neo-go)](https://goreportcard.com/report/github.com/nspcc-dev/neo-go)
[![GoDoc](https://godoc.org/github.com/nspcc-dev/neo-go?status.svg)](https://godoc.org/github.com/nspcc-dev/neo-go)
![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/nspcc-dev/neo-go?sort=semver) ![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/nspcc-dev/neo-go?sort=semver)
![License](https://img.shields.io/github/license/nspcc-dev/neo-go.svg?style=popout) ![License](https://img.shields.io/github/license/nspcc-dev/neo-go.svg?style=popout)
# 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-2.x**) is a stable version of the project compatible
with Neo 2, it only receives bug fixes and minor updates. For the Neo 3
development version please refer to the [**master**
branch](https://github.com/nspcc-dev/neo-go/tree/master) and releases
after 0.90.0. Releases before 0.80.0 (**0.7X.Y** track) are made from this
branch and only contain Neo 2 code.
# Getting started # Getting started
@ -101,7 +106,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 +119,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