Added README.md and docs

Author: sn-ntu

CONTRIBUTING.md

@@ -0,0 +1,43 @@
+# Contributing to java-mcashchain
+
+java-mcashchain is an open source project.
+
+It is the work of contributors. We appreciate your help!
+
+Here are instructions to get you started. They are not perfect, so
+please let us know if anything feels wrong or incomplete.
+
+## Contribution guidelines
+
+### Pull requests
+
+First of all, java-mcashchain follows [gitflow workflow](
+https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow).
+Please open pull requests to the **develop** branch. Once approved,
+we will close the pull request and merge into master branch.
+
+We are always happy to receive pull requests, and do our best to
+review them as fast as possible. Not sure if that typo is worth a pull
+request? Do it! We would appreciate it.
+
+If your pull request is not accepted on the first try, don't be
+discouraged as it can be a possible oversight. Please explain your code as
+detailed as possible to make it easier for us to understand.
+
+### Create issues
+
+Any significant improvement should be documented as [a GitHub
+issue](https://github.com/MidasCore/java-mcashchain/issues) before anyone
+starts working on it.
+
+When filing an issue, make sure to answer these three questions:
+
+- What did you do?
+- What did you expect to see?
+- What did you see instead?
+
+### Please check existing issues and docs first!
+
+Please take a moment to check that your bug report or improvement proposal
+doesn't already exist. If it does, please add a quick "+1" or "I have this problem too".
+This will help prioritize the most common problems and requests.

README.md

@@ -0,0 +1,83 @@
+<h4 align="center">
+  Java implementation of the <a href="https://mcash.network">Mcashchain</a>
+</h4>
+
+<p align="center">
+  <a href="https://t.me/McashchainDeveloper">
+    <img src="https://img.shields.io/badge/chat-on%20discord-brightgreen.svg">
+  </a>
+
+  <a href="https://github.com/MidasCore/java-mcashchain/issues">
+    <img src="https://img.shields.io/github/issues/MidasCore/java-mcashchain.svg">
+  </a>
+
+  <a href="https://github.com/MidasCore/java-mcashchain/pulls">
+    <img src="https://img.shields.io/github/issues-pr/MidasCore/java-mcashchain.svg">
+  </a>
+
+  <a href="https://github.com/MidasCore/java-mcashchain/graphs/contributors">
+    <img src="https://img.shields.io/github/contributors/MidasCore/java-mcashchain.svg">
+  </a>
+
+  <a href="LICENSE">
+    <img src="https://img.shields.io/github/license/MidasCore/java-mcashchain.svg">
+  </a>
+</p>
+
+<p align="center">
+  <a href="#deploy">Deploy</a> •
+  <a href="#developer-community">Community</a> •
+  <a href="http://developers.tron.network">Documentation</a> •
+  <a href="#contributing">Contributing</a> •
+  <a href="#projects">Projects</a> •
+  <a href="#resource">Resource</a>
+</p>
+
+## MCashChain?
+
+MCashChain aims to provide a solution for one of our ambitious projects which aims to challenge Ebay’s Model on Blockchain. As we all know, the lengthy block confirmation time and the high gas price have made it a great challenge to auction, bid or make use of the smart contracts. Moreover, the greater adoption of cryptocurrencies require the public blockchain to achieve high throughput at low fees to enable micropayment for E-commerce and high speed for online decentralized gaming experience. We are working towards a blockchain-based
+
+#### Main features:
+* Instant transfer with LightningSend™
+* Block time 3 seconds
+* Zero fees
+* 64 Supernodes for 40% p.a average ROI
+* Unlimited 4 level staking nodes 30% p.a average ROI
+* Monitoring and real time reward settlement on Midas Wallet
+* Crosschain swap enable on Unidex
+* MCash dApp Studio - 1st IDE for intuitive dapp programming
+
+# Deploy
+* [Build](doc/build.md) Build java-mcashchain
+* [Run](doc/run.md) Run java-mcashchain
+
+# Community
+
+* [Developer Telegram group](https://t.me/McashchainDeveloper) Please join our Developer Telegram group
+* [Global Telegram group](https://t.me/Mcashchain) Please join our Global Telegram group
+
+# Projects
+* [Mcashchain Java implementation](https://github.com/MidasCore/java-mcashchain)
+* [Wallet Web - Chrome/Brave extension](https://chrome.google.com/webstore/detail/loiopaejobjggipodncmajcmdolegdan)
+* [Wallet Android app](https://play.google.com/store/apps/details?id=com.midasprotocol.wallet.android)
+* [Wallet IOS app](https://itunes.apple.com/us/app/midas-protocol-crypto-wallet/id1436698193)
+
+# Resource
+* [Website](https://mcash.network/)
+* [Documentation](https://github.com/MidasCore/mcashchain/wiki)
+* [Blog](https://medium.com/mcashchain)
+* [Mcashscan](https://mcashscan.io/)
+* [White Paper 0.8.3](http://bit.ly/mcashchain-wp-graphic)
+* [Mcashchain Quickstart](https://github.com/MidasCore/mcashchain/wiki/getting-started-1)
+* [About](https://mcash.network/about)
+* [FAQ](https://mcash.network/faq)
+
+# Contributing
+Thank you for all of [our contributors](https://github.com/MidasCore/java-mcashchain/graphs/contributors); this project wouldn’t be what it is without you! If you want to help out, please see [CONTRIBUTING.md](CONTRIBUTING.md).
+
+If you'd like to contribute to java-mcashchain, please fork, fix, commit and send a pull request for the maintainers to review and merge into the main code base.
+If you wish to submit more complex changes though, please check up with the core devs first on [our telegram channel](https://t.me/McashchainDeveloper) to ensure those changes are
+in line with the general philosophy of the project and/or get some early feedback which can make both your efforts much lighter as well as our review and merge procedures quick and simple.
+
+# License
+* [LGPL-3.0](https://github.com/MidasCore/java-mcashchain/blob/master/LICENSE)

docs/Solidity_and_Full_Node_Deployment_EN.md

@@ -0,0 +1,91 @@
+# Deployment of SolidityNode and FullNode on the same host
+
+Create separate directories for fullnode and soliditynode
+```
+    /deploy/fullnode
+    /deploy/soliditynode
+```
+
+Create two folders for fullnode and soliditynode.
+
+Clone our latest master branch of https://github.com/MidasCore/java-mcashchain and extract it to
+```      
+    /deploy/java-mcashchain 
+```
+
+Make sure you have the proper dependencies.
+
+* JDK 1.8 (JDK 1.9+ is not supported yet)
+* On Linux Ubuntu system (e.g. Ubuntu 16.04.4 LTS), ensure that the machine has [__Oracle JDK 8__](https://www.digitalocean.com/community/tutorials/how-to-install-java-with-apt-get-on-ubuntu-16-04), instead of having __Open JDK 8__ in the system. If you are building the source code by using __Open JDK 8__, you will get [__Build Failed__](https://github.com/MidasCore/java-mcashchain/issues/337) result.
+* Open **UDP** ports for connection to the network
+* **MINIMUM** 2 CPU Cores
+
+## Deployment guide
+
+  1. Build the java-mcashchain project
+```
+    cd /deploy/java-mcashchain 
+    ./gradlew build
+```
+
+  2. Copy the FullNode.jar and SolidityNode.jar along with config files into the respective directories.
+```
+    download your needed config file from https://github.com/MidasCore/java-mcashchain/tree/master/src/main/resources.
+    config.conf is the config for mainnet, and config-testnet.conf is the config for testnet.
+    please rename the config file to `config.conf` and use this config.conf to start fullnode and soliditynode.
+
+    cp build/libs/FullNode.jar ../fullnode
+    cp build/libs/SolidityNode.jar ../soliditynode
+```
+
+  3. You can now run your Fullnode using the following command：
+```
+      java -jar FullNode.jar -c config.conf // make sure that you download the latest version of config.conf from https://github.com/MidasCore/java-mcashchain/releases
+```
+
+  4. Configure the SolidityNode configuration file. You'll need to edit `config.conf` to connect to your local `FullNode`. Change  `trustNode` in `node` to local `127.0.0.1:60061`, which is the default rpc port. Set `listen.port` to any number within the range of 1024-65535. Please don't use any ports between 0-1024 since you'll most likely hit conflicts with other system services. Also change `rpc port` to `60062` or something to avoid conflicts. **Please forward the UDP port 18888 for FullNode.**
+```
+    rpc {
+      port = 60062
+    }
+```
+
+  5. You can now run your SolidityNode using the following command：
+```        
+    java -jar SolidityNode.jar -c config.conf // make sure that you download the latest version of config.conf from https://github.com/MidasCore/java-mcashchain/releases
+```
+
+# Logging and network connection verification
+
+Logs for both nodes are located in `/deploy/\*/logs/mcashchain.log`. Use `tail -f /logs/mcashchain.log/` to follow along with the block syncing.
+
+You should see something similar to this in your logs for block synchronization:
+
+## FullNode
+
+      08:00:30.192 INFO  [ClientWorker-3] [i.m.c.n.s.AdvService](AdvService.java:126) Ready to broadcast block Num:378817,ID:000000000005c7c1994715cdc94410877391045061f745303fe48f30e49730cf
+      08:00:30.195 INFO  [ClientWorker-0] [net](MessageQueue.java:98) Receive from /138.197.7.138:11399, type: INVENTORY
+invType: BLOCK, size: 1, First hash: 000000000005c7c1994715cdc94410877391045061f745303fe48f30e49730cf
+
+
+## SolidityNode
+
+      20:06:10.866 INFO  [Thread-14] [app](SolidityNode.java:142) Get last remote solid blockNum: 0, remoteBlockNum: 0, cost: 4
+      
+# Stop node gracefully
+Create file stop.sh，use kill -15 to close java-mcashchain.jar（or FullNode.jar、SolidityNode.jar）.
+You need to modify pid=`ps -ef |grep java-mcashchain.jar |grep -v grep |awk '{print $2}'` to find the correct pid.
+```
+#!/bin/bash
+while true; do
+  pid=`ps -ef |grep java-mcashchain.jar |grep -v grep |awk '{print $2}'`
+  if [ -n "$pid" ]; then
+    kill -15 $pid
+    echo "The java-mcashchain process is exiting, it may take some time, forcing the exit may cause damage to the database, please wait patiently..."
+    sleep 1
+  else
+    echo "java-mcashchain killed successfully!"
+    break
+  fi
+done
+```

docs/build.md

@@ -0,0 +1,80 @@
+# How to Build
+
+## Prepare dependencies
+
+* JDK 1.8 (JDK 1.9+ are not supported yet)
+* On Linux Ubuntu system (e.g. Ubuntu 18.04 LTS), ensure that the machine has [__Oracle JDK 8__](https://www.digitalocean.com/community/tutorials/how-to-install-java-with-apt-get-on-ubuntu-16-04), instead of having __Open JDK 8__ in the system. If you are building the source code by using __Open JDK 8__, you will get [__Build Failed__](https://github.com/MidasCore/java-mcashchain/issues/337) result.
+* Open **UDP** ports for connection to the network
+* **MINIMUM** 2 ENERGY Cores
+
+## Getting the code with git
+
+* Use Git from the Terminal, see the [Setting up Git](https://help.github.com/articles/set-up-git/) and [Fork a Repo](https://help.github.com/articles/fork-a-repo/) articles.
+* develop branch: the newest code 
+* master branch: more stable than develop.
+In the shell command, type:
+```bash
+git clone https://github.com/MidasCore/java-mcashchain.git
+git checkout -t origin/master
+```
+
+* For Mac, you can also install **[GitHub for Mac](https://mac.github.com/)** then **[fork and clone our repository](https://guides.github.com/activities/forking/)**. 
+
+* If you'd rather not use Git, [Download the ZIP](https://github.com/MidasCore/java-mcashchain/archive/develop.zip)
+
+## Including java-mcashchain as dependency
+
+* If you don't want to checkout the code and build the project, you can include it directly as a dependency
+
+**Using gradle:**
+
+```
+repositories {
+   maven { url 'https://jitpack.io' }
+}
+dependencies {
+   implementation 'com.github.MidasCore:java-mcashchain:develop-SNAPSHOT'
+}
+```
+  
+**Using maven:**
+
+```xml
+...
+<repositories>
+  <repository>    
+      <id>jitpack.io</id>
+      <url>https://jitpack.io</url>
+  </repository>
+</repositories>
+...
+<dependency>
+    <groupId>com.github.MidasCore</groupId>
+    <artifactId>java-mcashchain</artifactId>
+    <version>develop-SNAPSHOT</version><!--You can use any of the tag/branch name available-->
+</dependency>
+```
+
+
+
+
+## Building from source code
+
+* Build in the Terminal
+
+```bash
+cd java-mcashchain
+./gradlew build
+```
+
+
+* Build in [IntelliJ IDEA](https://www.jetbrains.com/idea/) (community version is enough):
+
+  **Please run ./gradlew build once to build the protocol files**
+
+  1. Start IntelliJ. Select `File` -> `Open`, then locate to the java-mcashchain folder which you have git cloned to your local drive. Then click `Open` button on the right bottom.
+  2. Check on `Use auto-import` on the `Import Project from Gradle` dialog. Select JDK 1.8 in the `Gradle JVM` option. Then click `OK`.
+  3. IntelliJ will open the project and start gradle syncing, which will take several minutes, depending on your network connection and your IntelliJ configuration
+  4. Enable Annotations, `Preferences` -> Search `annotations` -> check `Enable Annotation Processing`.
+  5. After the syncing finished, select `Gradle` -> `Tasks` -> `build`, and then double click `build` option.
+