Added Docs into README how to setup

nucocloud · Aug 8, 2019 · fe5c056 · fe5c056
1 parent 2a15e74
commit fe5c056
Show file tree

Hide file tree

Showing 5 changed files with 55 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -1,3 +1,46 @@
+
+# What is it about?
+
+The NCDT-Token are part of the ICO of Nuco.Cloud.
+
+URL: https://nuco.cloud/
+Whitepaper: https://nuco.cloud/#whitepaper
+FAQ: https://nuco.cloud/#faq 
+
+# Getting started
+
+## Prerequisites
+
+Install the following tools globally (or using npx)
+- node
+- npm
+- ganache-cli
+- truffle-suite
+
+## Installation
+
+Checkout and intall dependencies
+
+```
+git clone git@github.com:nucocloud/ncd-token.git
+cd ncd-token
+npm install 
+```
+
+## Running tests:
+
+1. start ganache
+
+```
+ganache-cli --mnemonic “your twelve word mnemonic here”
+```
+
+2. In a new terminal, run tests:
+
+```
+truffle test
+```
+
 # Vesting / Team Tokens
 
 

diff --git a/test/integration/NCDTeamTokenIntegrationTest.js b/test/integration/NCDTeamTokenIntegrationTest.js
@@ -8,11 +8,10 @@ const TokenVesting = artifacts.require("TokenVestingImpl");
 const NCDToken = artifacts.require('NCDTokenImpl');
 const NCDTokenSale = artifacts.require('NCDTokenSaleImpl');
 
-const ONE_YEAR_IN_SECONDS = 86400 * 31 * 12;
+const ONE_YEAR_IN_SECONDS = 86400 * 31 * 12; // SIMPLIFIED FOR our tests here (31 days per month)
 const ONE_MONTH_PERIOD_IN_SECONDS = 86400 * 31; // 31 days for a ideal month
 const RELEASE_RATE_PER_MONTH = 10;
 
-return;
 contract("TeamToken Integration tests", async ([_, owner, buyer, another, vesting, pauser1, pauser2, vestor1, vestor2, ...otherAccounts]) => {
 
     before(async function () {

diff --git a/test/integration/NCDTeamTokenIntegrationTest2.js b/test/integration/NCDTeamTokenIntegrationTest2.js
@@ -8,7 +8,7 @@ const TokenVesting = artifacts.require("TokenVestingImpl");
 const NCDToken = artifacts.require('NCDTokenImpl');
 const NCDTokenSale = artifacts.require('NCDTokenSaleImpl');
 
-const ONE_YEAR_IN_SECONDS = 86400 * 31 * 12;
+const ONE_YEAR_IN_SECONDS = 86400 * 31 * 12; // SIMPLIFIED FOR our tests here (31 days per month)
 const ONE_MONTH_PERIOD_IN_SECONDS = 86400 * 31; // 31 days for a ideal month
 const RELEASE_RATE_PER_MONTH = 10;
 

diff --git a/truffle-config.js b/truffle-config.js
@@ -66,7 +66,7 @@ module.exports = {
       gasPrice: 0x01      // <-- Use this low gas price
     },
   },
-  mocha: {
+  _mocha: {
     reporter: (!process.env.SOLIDITY_COVERAGE) ? 'eth-gas-reporter' : 'spec',
     reporterOptions : {
       currency: 'EUR',

diff --git a/zos.ropsten.json b/zos.ropsten.json
@@ -590,6 +590,15 @@
         "admin": "0x44Ab61e9b9E32a8Da7aC804969D3803DA10d8b1F",
         "kind": "Upgradeable"
       }
+    ],
+    "ncdt/TokenVesting": [
+      {
+        "address": "0x4685e6402a6BD5b98B0E61A553dc24F5458d4C4c",
+        "version": "v1.3.0",
+        "implementation": "0x0C19D6baEF6Eb7C1889Dc12F26896B61b56dbfFf",
+        "admin": "0x44Ab61e9b9E32a8Da7aC804969D3803DA10d8b1F",
+        "kind": "Upgradeable"
+      }
     ]
   },
   "zosversion": "2.2",