grassrootseconomics/openethereum
5
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

docs: add parity ethereum logo to readme (#9415)

Browse Source 
* docs: add parity ethereum logo

* docs: add logo to readme

* docs: align logo center

* docs: remove separators from readme

* docs: restructure readme

* docs: check spelling and grammar in readme

* docs: clarify readme

* docs: improve readme significantly
This commit is contained in:
Afri Schoedon 2018-08-27 17:01:56 +02:00 committed by Thibaut Sardan
parent ac1900a0fc
commit 6c96b60a63
2 changed files with 59 additions and 57 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

115
README.md
View File

@ -1,52 +1,44 @@
## Parity-Ethereum - a fast, light, and robust EVM and WASM blockchain client ![Parity Ethereum](docs/logo-parity-ethereum.svg)
### [» Download the latest release «](https://github.com/paritytech/parity-ethereum/releases/latest) ## The fastest and most advanced Ethereum client.
[![build status](https://gitlab.parity.io/parity/parity/badges/master/build.svg)](https://gitlab.parity.io/parity/parity/commits/master) <p align="center"><strong><a href="https://github.com/paritytech/parity-ethereum/releases/latest">» Download the latest release «</a></strong></p>
[![codecov](https://codecov.io/gh/paritytech/parity-ethereum/branch/master/graph/badge.svg)](https://codecov.io/gh/paritytech/parity-ethereum)
[![Snap Status](https://build.snapcraft.io/badge/paritytech/parity.svg)](https://build.snapcraft.io/user/paritytech/parity)
[![GPLv3](https://img.shields.io/badge/license-GPL%20v3-green.svg)](https://www.gnu.org/licenses/gpl-3.0.en.html)
<p align="center"><a href="https://gitlab.parity.io/parity/parity/commits/master" target="_blank"><img src="https://gitlab.parity.io/parity/parity/badges/master/build.svg" /></a>
<a href="https://codecov.io/gh/paritytech/parity-ethereum" target="_blank"><img src="https://codecov.io/gh/paritytech/parity-ethereum/branch/master/graph/badge.svg" /></a>
<a href="https://build.snapcraft.io/user/paritytech/parity" target="_blank"><img src="https://build.snapcraft.io/badge/paritytech/parity.svg" /></a>
<a href="https://www.gnu.org/licenses/gpl-3.0.en.html" target="_blank"><img src="https://img.shields.io/badge/license-GPL%20v3-green.svg" /></a></p>
### Join the chat! **Built for mission-critical use**: Miners, service providers, and exchanges need fast synchronisation and maximum uptime. Parity Ethereum provides the core infrastructure essential for speedy and reliable services.
Get in touch with us on Gitter: - Clean, modular codebase for easy customisation
[![Gitter: Parity](https://img.shields.io/badge/gitter-parity-4AB495.svg)](https://gitter.im/paritytech/parity) - Advanced CLI-based client
[![Gitter: Parity.js](https://img.shields.io/badge/gitter-parity.js-4AB495.svg)](https://gitter.im/paritytech/parity.js) - Minimal memory and storage footprint
[![Gitter: Parity/Miners](https://img.shields.io/badge/gitter-parity/miners-4AB495.svg)](https://gitter.im/paritytech/parity/miners) - Synchronise in hours, not days with Warp Sync
[![Gitter: Parity-PoA](https://img.shields.io/badge/gitter-parity--poa-4AB495.svg)](https://gitter.im/paritytech/parity-poa) - Modular for light integration into your service or product
Or join our community on Matrix: ## Technical Overview
[![Riot: +Parity](https://img.shields.io/badge/riot-%2Bparity%3Amatrix.parity.io-orange.svg)](https://riot.im/app/#/group/+parity:matrix.parity.io)
Official website: https://parity.io | Be sure to check out [our wiki](https://wiki.parity.io) for more information. Parity Ethereum's goal is to be the fastest, lightest, and most secure Ethereum client. We are developing Parity Ethereum using the sophisticated and cutting-edge **Rust programming language**. Parity Ethereum is licensed under the GPLv3 and can be used for all your Ethereum needs.
---- By default, Parity Ethereum runs a JSON-RPC HTTP server on port `:8545` and a Web-Sockets server on port `:8546`. This is fully configurable and supports a number of APIs.
## About Parity-Ethereum If you run into problems while using Parity Ethereum, check out the [wiki for documentation](https://wiki.parity.io/), feel free to [file an issue in this repository](https://github.com/paritytech/parity-ethereum/issues/new), or hop on our [Gitter](https://gitter.im/paritytech/parity) or [Riot](https://riot.im/app/#/group/+parity:matrix.parity.io) chat room to ask a question. We are glad to help! **For security-critical issues**, please refer to the security policy outlined in [SECURITY.md](SECURITY.md).
Parity-Ethereum's goal is to be the fastest, lightest, and most secure Ethereum client. We are developing Parity-Ethereum using the sophisticated and cutting-edge Rust programming language. Parity-Ethereum is licensed under the GPLv3, and can be used for all your Ethereum needs. Parity Ethereum's current beta-release is 2.0. You can download it at [the releases page](https://github.com/paritytech/parity-ethereum/releases) or follow the instructions below to build from source. Please, mind the [CHANGELOG.md](CHANGELOG.md) for a list of all changes between different versions.
By default, Parity-Ethereum will run a JSON-RPC HTTP server on `127.0.0.1:8545` and a Web-Sockets server on `127.0.0.1:8546`. This is fully configurable and supports a number of APIs. ## Build Dependencies
If you run into problems while using Parity-Ethereum, feel free to file an issue in this repository or hop on our [Gitter](https://gitter.im/paritytech/parity) or [Riot](https://riot.im/app/#/group/+parity:matrix.parity.io) chat room to ask a question. We are glad to help! **For security-critical issues**, please refer to the security policy outlined in [SECURITY.md](SECURITY.md). Parity Ethereum requires **Rust version 1.28.x** to build.
Parity-Ethereum's current beta-release is 2.0. You can download it at [the releases page](https://github.com/paritytech/parity-ethereum/releases) or follow the instructions below to build from source. Please, mind the [CHANGELOG.md](CHANGELOG.md) for a list of all changes between different versions. We recommend installing Rust through [rustup](https://www.rustup.rs/). If you don't already have `rustup`, you can install it like this:
----
## Build dependencies
**Parity-Ethereum requires Rust version 1.27.0 to build**
We recommend installing Rust through [rustup](https://www.rustup.rs/). If you don't already have rustup, you can install it like this:
- Linux: - Linux:
```bash ```bash
$ curl https://sh.rustup.rs -sSf | sh $ curl https://sh.rustup.rs -sSf | sh
``` ```
Parity-Ethereum also requires `gcc`, `g++`, `libudev-dev`, `pkg-config`, `file`, `make`, and `cmake` packages to be installed. Parity Ethereum also requires `gcc`, `g++`, `libudev-dev`, `pkg-config`, `file`, `make`, and `cmake` packages to be installed.
- OSX: - OSX:
```bash ```bash
@ -56,21 +48,19 @@ We recommend installing Rust through [rustup](https://www.rustup.rs/). If you do
`clang` is required. It comes with Xcode command line tools or can be installed with homebrew. `clang` is required. It comes with Xcode command line tools or can be installed with homebrew.
- Windows - Windows
Make sure you have Visual Studio 2015 with C++ support installed. Next, download and run the rustup installer from Make sure you have Visual Studio 2015 with C++ support installed. Next, download and run the `rustup` installer from
https://static.rust-lang.org/rustup/dist/x86_64-pc-windows-msvc/rustup-init.exe, start "VS2015 x64 Native Tools Command Prompt", and use the following command to install and set up the msvc toolchain: https://static.rust-lang.org/rustup/dist/x86_64-pc-windows-msvc/rustup-init.exe, start "VS2015 x64 Native Tools Command Prompt", and use the following command to install and set up the `msvc` toolchain:
```bash ```bash
$ rustup default stable-x86_64-pc-windows-msvc $ rustup default stable-x86_64-pc-windows-msvc
``` ```
Once you have rustup installed, then you need to install: Once you have `rustup` installed, then you need to install:
* [Perl](https://www.perl.org) * [Perl](https://www.perl.org)
* [Yasm](https://yasm.tortall.net) * [Yasm](https://yasm.tortall.net)
Make sure that these binaries are in your `PATH`. After that you should be able to build Parity-Ethereum from source. Make sure that these binaries are in your `PATH`. After that, you should be able to build Parity Ethereum from source.
---- ## Install from the Snapcraft Store
## Install from the snap store
In any of the [supported Linux distros](https://snapcraft.io/docs/core/install): In any of the [supported Linux distros](https://snapcraft.io/docs/core/install):
@ -78,24 +68,22 @@ In any of the [supported Linux distros](https://snapcraft.io/docs/core/install):
sudo snap install parity sudo snap install parity
``` ```
Or, if you want to contribute testing the upcoming release: Alternatively, if you want to contribute testing the upcoming release:
```bash ```bash
sudo snap install parity --beta sudo snap install parity --beta
``` ```
And to test the latest code landed into the master branch: Moreover, to test the latest code from the master branch:
```bash ```bash
sudo snap install parity --edge sudo snap install parity --edge
``` ```
---- ## Build from Source Code
## Build from source
```bash ```bash
# download Parity-Ethereum code # download Parity Ethereum code
$ git clone https://github.com/paritytech/parity-ethereum $ git clone https://github.com/paritytech/parity-ethereum
$ cd parity-ethereum $ cd parity-ethereum
@ -103,7 +91,7 @@ $ cd parity-ethereum
$ cargo build --release --features final $ cargo build --release --features final
``` ```
This will produce an executable in the `./target/release` subdirectory. This produces an executable in the `./target/release` subdirectory.
Note: if cargo fails to parse manifest try: Note: if cargo fails to parse manifest try:
@ -117,7 +105,7 @@ Note, when compiling a crate and you receive errors, it's in most cases your out
$ cargo clean $ cargo clean
``` ```
This will always compile the latest nightly builds. If you want to build stable or beta, do a This always compiles the latest nightly builds. If you want to build stable or beta, do a
```bash ```bash
$ git checkout stable $ git checkout stable
@ -129,11 +117,7 @@ or
$ git checkout beta $ git checkout beta
``` ```
first. ## Simple One-Line Installer for Mac and Linux
----
## Simple one-line installer for Mac and Ubuntu
```bash ```bash
bash <(curl https://get.parity.io -L) bash <(curl https://get.parity.io -L)
@ -145,22 +129,39 @@ The one-line installer always defaults to the latest beta release. To install a
bash <(curl https://get.parity.io -L) -r stable bash <(curl https://get.parity.io -L) -r stable
``` ```
## Start Parity-Ethereum ## Start Parity Ethereum
### Manually ### Manually
To start Parity-Ethereum manually, just run To start Parity Ethereum manually, just run
```bash ```bash
$ ./target/release/parity $ ./target/release/parity
``` ```
and Parity-Ethereum will begin syncing the Ethereum blockchain. so Parity Ethereum begins syncing the Ethereum blockchain.
### Using systemd service file ### Using `systemd` service file
To start Parity-Ethereum as a regular user using systemd init: To start Parity Ethereum as a regular user using `systemd` init:
1. Copy `./scripts/parity.service` to your 1. Copy `./scripts/parity.service` to your
systemd user directory (usually `~/.config/systemd/user`). `systemd` user directory (usually `~/.config/systemd/user`).
2. To configure Parity-Ethereum, write a `/etc/parity/config.toml` config file, see [Configuring Parity-Ethereum](https://paritytech.github.io/wiki/Configuring-Parity) for details. 2. To configure Parity Ethereum, write a `/etc/parity/config.toml` config file, see [Configuring Parity Ethereum](https://paritytech.github.io/wiki/Configuring-Parity) for details.
## Join the chat!
Questions? Get in touch with us on Gitter:
[![Gitter: Parity](https://img.shields.io/badge/gitter-parity-4AB495.svg)](https://gitter.im/paritytech/parity)
[![Gitter: Parity.js](https://img.shields.io/badge/gitter-parity.js-4AB495.svg)](https://gitter.im/paritytech/parity.js)
[![Gitter: Parity/Miners](https://img.shields.io/badge/gitter-parity/miners-4AB495.svg)](https://gitter.im/paritytech/parity/miners)
[![Gitter: Parity-PoA](https://img.shields.io/badge/gitter-parity--poa-4AB495.svg)](https://gitter.im/paritytech/parity-poa)
Alternatively, join our community on Matrix:
[![Riot: +Parity](https://img.shields.io/badge/riot-%2Bparity%3Amatrix.parity.io-orange.svg)](https://riot.im/app/#/group/+parity:matrix.parity.io)
## Documentation
Official website: https://parity.io
Be sure to [check out our wiki](https://wiki.parity.io) for more information.

1
docs/logo-parity-ethereum.svg Normal file
View File

File diff suppressed because one or more lines are too long
Side by Side

After

Width:  |  Height:  |  Size: 7.9 KiB