@@ -7,8 +7,10 @@ high-performance, horizontally scalable, blockchain infrastructure upon which de
can be built.
This code is currently alpha-quality and under rapid development. That said,
there is plenty early experimenters can do including, running a private multi-node test network and
develop applications (smart contracts).
there is plenty early experimenters can do including running a private multi-node test network and
developing applications (smart contracts).
The public testnet described in the [wiki](https://github.com/EOSIO/eos/wiki/Testnet%3A%20Public) is running the `dawn-2.x` branch. The `master` branch is no longer compatible with the public testnet. Instructions are provided below for building either option.
8.[Manual installation of the dependencies](#manualdep)
6.[Running a node on the public testnet](#publictestnet)
7.[Doxygen documentation](#doxygen)
8.[Running EOS in Docker](#docker)
9.[Manual installation of the dependencies](#manualdep)
1.[Clean install Ubuntu 16.10](#ubuntu)
2.[MacOS Sierra 10.12.6](#macos)
<aname="gettingstarted"></a>
## Getting Started
The following instructions overview the process of getting the software, building it, running a simple test network that produces blocks, creating an account, and uploading a sample contract to the blockchain.
The following instructions detail the process of getting the software, building it, running a simple test network that produces blocks, account creation and uploading a sample contract to the blockchain.
<aname="setup"></a>
## Setting up a build/development environment
...
...
@@ -54,21 +59,21 @@ The following instructions overview the process of getting the software, buildin
<aname="autobuild"></a>
### Automated build script
For Ubuntu 16.10 and MacOS Sierra, there is an automated build script that can install all dependencies and build EOS.
For Ubuntu 16.10 and MacOS Sierra, there is an automated build script that can install all dependencies and builds EOS.
It is called build.sh with the following inputs:
It is called build.sh with the following inputs.
- architecture [ubuntu|darwin]
- optional mode [full|build]
The second optional input can be `full` or `build` where `full` implies that it installs dependencies and builds EOS. If you omit this input, then the build script will install dependencies and then builds EOS.
The second optional input can be `full` or `build` where `full` implies that it installs dependencies and builds eos. If you omit this input then the build script installs dependencies and then builds eos.
```bash
./build.sh <architecture> <optional mode>
```
Clone EOS repository recursively as below and run build.sh located in root `eos` folder.
Choose whether you will be building for a local testnet or for the public testnet and jump to the appropriate section below. Clone the EOS repository recursively as described and run build.sh located in the root `eos` folder.
<aname="autoubuntu"></a>
#### Clean install Ubuntu 16.10
<aname="autoubuntulocal"></a>
#### Clean install Ubuntu 16.10 for a local testnet
Now you can proceed to the next step - [Running a node on the public testnet](#publictestnet)
<aname="runanode"></a>
## Building EOS and running a node
...
...
@@ -142,15 +184,15 @@ EOS comes with a number of programs you can find in `~/eos/build/programs`. They
* eosiod - server-side blockchain node component
* eosioc - command line interface to interact with the blockchain
* eos-walletd - EOS wallet
* eosio-walletd - EOS wallet
* launcher - application for nodes network composing and deployment; [more on launcher](https://github.com/EOSIO/eos/blob/master/testnet.md)
<aname="singlenode"></a>
### Creating and launching a single-node testnet
After successfully building the project, the `eosiod` binary should be present in the `build/programs/eosiod` directory. Go ahead and run `eosiod` -- it will probably exit with an error, but if not, close it immediately with <kbd>Ctrl-C</kbd>. Note that `eosiod` created a directory named `data-dir` containing the default configuration (`config.ini`) and some other internals. This default data storage path can be overridden by passing `--data-dir /path/to/data` to `eosiod`.
After successfully building the project, the `eosiod` binary should be present in the `build/programs/eosiod` directory. Run `eosiod` -- it will probably exit with an error, but if not, close it immediately with <kbd>Ctrl-C</kbd>. If it exited with an error, note that `eosiod` created a directory named `data-dir` containing the default configuration (`config.ini`) and some other internals. This default data storage path can be overridden by passing `--data-dir /path/to/data` to `eosiod`. These instructions will continue to use the default directory.
Edit the `config.ini` file, adding the following settings to the defaults already in place:
Edit the `config.ini` file, adding/updating the following settings to the defaults already in place:
```
# Load the testnet genesis state, which creates some initial block producers with the default key
...
...
@@ -246,7 +288,7 @@ This will output two pairs of public and private keys