From abe83d47e6389c0b071dbe576cdac66ab93c4477 Mon Sep 17 00:00:00 2001 From: Richard Ramos Date: Mon, 7 May 2018 09:28:55 -0400 Subject: [PATCH] Updating readme --- README.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b310cce..da3b776 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,19 @@ # Contracts + +## Installation +1. Install Embark with `npm install -g embark` +2. Browse the folder where the contract repository has been cloned and execute `npm install` +3. Execute `embark blockchain` to run a private node, or `embark simulator` for testrpc +4. Execute `embark run` to compile contracts and run webserver (if applies). + +If you need to access the abi for the contracts, after running the previous commands, they will be available in the folder `./dist/contracts/` + +See more information about Embark framework here: https://embark.status.im/ + +## Projects + ### Tribute to talk - Idea #96 Tribute to Talk - [Link](https://ideas.status.im/ideas/96-message-tributes) -- Documentation: [TributeToTalk.md](TributeToTalk.md) \ No newline at end of file +- Documentation: [TributeToTalk.md](TributeToTalk.md) +- Running test - After executing `embark run` to compile the contracts, `node test/messageSigned-test.js` This will be changed in the future to run with `embark test`