Merge pull request #55 from markspanbroek/add-build-instructions

Add rudimentary build & test instructions to Readme
This commit is contained in:
Yuriy Glukhov 2018-06-20 15:09:28 +03:00 committed by GitHub
commit 361e41f688
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 0 deletions

View File

@ -13,6 +13,12 @@ Join the Status community chats:
## Rationale
[Nimbus: an Ethereum 2.0 Sharding Client](https://github.com/status-im/nimbus/blob/master/doc/Nimbus%20-%20An%20Ethereum%202.0%20Sharding%20Client_xt.md)
## Building & Testing
Currently Nimbus requires the latest development version of the Nim programming language. Follow the [installation steps](https://github.com/nim-lang/Nim) or use [choosenim](https://github.com/dom96/choosenim).
You can build the package and run the tests using `nimble test`. You can run the example using `nim compile --run examples/decompile_smart_contract.nim`.
## License
Licensed under one of the following: