diff --git a/README.md b/README.md index e9882656..c90a2ccc 100644 --- a/README.md +++ b/README.md @@ -5,45 +5,53 @@ - Proof-of-Stake (PoS) Blockchain - with a WASM Runtime. -Developer resources are available at [edgewa.re/dev](https://edgewa.re/dev/) and more detailed documentation at the [Github Wiki](https://github.com/hicommonwealth/edgeware-node/wiki). For more details about the project, visit the Edgeware website, or check the [blog](blog.edgewa.re) or [Twitter](http://twitter.com/heystraightedge) for the latest. Finally, for discussion and governance, you can utilize [Commonwealth.im](https://commonwealth.im). +Developer resources are available at [Straightedge's Discord](https://discord.gg/ZRj9zRU). -We are now pegged to: https://github.com/hicommonwealth/substrate. +For more details about the project, visit the [Straightedge website](https://straighted.ge) or [Twitter](http://twitter.com/heystraightedge) for the latest. -## To get started +We are now pegged to: https://github.com/hicommonwealth/substrate. -- Download this entire repository to the file system that you are using to run the validator node. - - You can do this by going to [this page](https://github.com/hicommonwealth/edgeware-node) and selecting "Clone or download" followed by "Download ZIP". - - If you are installing via a command line interface (e.g. SSH into a remote server), you can dow-load by running `wget https://github.com/hicommonwealth/edgeware-node/archive/master.zip` - - Once you have downloaded the zip file, unzip the `edgeware-node-master` folder onto the file system. If you are using a command line interface, you can unzip by running `unzip master.zip` - - **_All commands referenced in this document need to be run from within the `edgeware-node-master` folder._** +## Get the software -- You will also need to install `rust` and `cargo` by installing `rustup` [here](https://rustup.rs/). - - **_Note_**: at the end of the install, you will need to log out and log in again, or run the suggested `source` command to configure the current shell. +Open a command line interface on the server you're installing on, and run the following commands: -## Fresh start -If your device is clean (such as a fresh cloud VM) you can use this script, otherwise, proceed with the *Initial Setup*. +- To download the latest version of the software: ``` -./setup.sh +wget https://github.com/heystraightedge/straightedge-node/archive/master.zip ``` -To create a keypair, install subkey with `cargo install --force --git https://github.com/paritytech/substrate subkey`. Then run the following: +- To unzip: ``` -subkey generate +unzip master.zip ``` -To create an ED25519 keypair, run the following: + +## Setup and build + +- To setup your environment and build the software, run the following command from within the `straightedge-node-master` folder: + ``` -subkey -e generate +./setup.sh ``` -To create derived keypairs, use the mnemonic generated from a method above and run (use `-e` for ED25519): + +This can take some time, so perhaps go outside, get some fresh air, and come back later. + +You will know it is complete when you see: + ``` -subkey inspect ""// + Compiling straightedge v0.8.0 (/home/straightedge-0/straightedge-node-master) + Finished release [optimized] target(s) in 12m 04s ``` -For example: + +### Run + +- Run the software by running the following commands from within the `straightedge-node-master` folder: + ``` -subkey inspect "west paper guide park design weekend radar chaos space giggle execute canoe"//edgewarerocks +./target/release/straightedge ``` -Then proceed to the *Running* instructions or follow the instructions below for the manual setup. -### Initial Setup + + +