From 77127db44ba554ce565872b177de7189f6f5db82 Mon Sep 17 00:00:00 2001 From: Mark Spanbroek Date: Tue, 19 Jun 2018 21:19:07 +0200 Subject: [PATCH] Add rudimentary build & test instructions to Readme Fixes #43 --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 910c2f5be..88eecb37e 100644 --- a/README.md +++ b/README.md @@ -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: