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

Update README (#11578)

Browse Source 
* Update README

* Update README.md

Co-Authored-By: David <dvdplm@gmail.com>

* Update README.md

Co-Authored-By: David <dvdplm@gmail.com>

* Update README.md

Co-Authored-By: David <dvdplm@gmail.com>

* more

* fix link

* discord badge style

Co-authored-by: David <dvdplm@gmail.com>
This commit is contained in:
Artem Vorotnikov 2020-03-18 21:22:51 +03:00 committed by GitHub
parent 70c4ed7fa0
commit bb2d7fb8c9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 66 additions and 92 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

92
README.md
View File

@ -1,11 +1,19 @@
![Open Ethereum](docs/logo-parity-ethereum.svg) # OpenEthereum
<h2 align="center">The Fastest and most Advanced Ethereum Client.</h2> Fast and feature-rich multi-network Ethereum client.
<p align="center"><strong><a href="https://github.com/OpenEthereum/open-ethereum/releases/latest">» Download the latest release «</a></strong></p> [» Download the latest release «](https://github.com/openethereum/openethereum/releases/latest)
<p align="center"><a href="https://github.com/OpenEthereum/open-ethereum/actions" target="_blank"><img src="https://github.com/OpenEthereum/open-ethereum/workflows/Build%20and%20Test%20Suite/badge.svg" /></a> [![GPL licensed][license-badge]][license-url]
<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> [![Build Status][ci-badge]][ci-url]
[![Discord chat][chat-badge]][chat-url]
[license-badge]: https://img.shields.io/badge/license-GPL_v3-green.svg
[license-url]: LICENSE
[ci-badge]: https://github.com/openethereum/openethereum/workflows/Build%20and%20Test%20Suite/badge.svg
[ci-url]: https://github.com/openethereum/openethereum/actions
[chat-badge]: https://img.shields.io/discord/669192218728202270.svg?logo=discord
[chat-url]: https://discord.io/openethereum
## Table of Contents ## Table of Contents
@ -18,9 +26,8 @@
4. [Testing](#chapter-004) 4. [Testing](#chapter-004)
5. [Documentation](#chapter-005) 5. [Documentation](#chapter-005)
6. [Toolchain](#chapter-006) 6. [Toolchain](#chapter-006)
7. [Community](#chapter-007) 7. [Contributing](#chapter-008)
8. [Contributing](#chapter-008) 8. [License](#chapter-009)
9. [License](#chapter-009)
## 1. Description <a id="chapter-001"></a> ## 1. Description <a id="chapter-001"></a>
@ -35,13 +42,13 @@
## 2. Technical Overview <a id="chapter-002"></a> ## 2. Technical Overview <a id="chapter-002"></a>
Open Ethereum's goal is to be the fastest, lightest, and most secure Ethereum client. We are developing Open Ethereum using the sophisticated and cutting-edge **Rust programming language**. Open Ethereum is licensed under the GPLv3 and can be used for all your Ethereum needs. OpenEthereum's goal is to be the fastest, lightest, and most secure Ethereum client. We are developing OpenEthereum using the **Rust programming language**. OpenEthereum is licensed under the GPLv3 and can be used for all your Ethereum needs.
By default, OpenEthereum 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. By default, OpenEthereum 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.
If you run into problems while using Open Ethereum, check out the [old wiki for documentation](https://wiki.parity.io/), feel free to [file an issue in this repository](https://github.com/OpenEthereum/open-ethereum/issues/new), or hop on our [Discord](https://discord.gg/FJUgGe) 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). If you run into problems while using OpenEthereum, check out the [old wiki for documentation](https://wiki.parity.io/), feel free to [file an issue in this repository](https://github.com/openethereum/openethereum/issues/new), or hop on our [Discord](https://discord.io/openethereum) chat room to ask a question. We are glad to help!
You can download Open Ethereum's latest release at [the releases page](https://github.com/OpenEthereum/open-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. You can download OpenEthereum's latest release at [the releases page](https://github.com/openethereum/openethereum/releases) or follow the instructions below to build from source. Read the [CHANGELOG.md](CHANGELOG.md) for a list of all changes between different versions.
## 3. Building <a id="chapter-003"></a> ## 3. Building <a id="chapter-003"></a>
@ -82,7 +89,7 @@ Make sure that these binaries are in your `PATH`. After that, you should be able
```bash ```bash
# download OpenEthereum code # download OpenEthereum code
$ git clone https://github.com/OpenEthereum/open-ethereum $ git clone https://github.com/openethereum/openethereum
$ cd open-ethereum $ cd open-ethereum
# build in release mode # build in release mode
@ -128,7 +135,7 @@ To start Open 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. Copy release to bin folder, write `sudo install ./target/release/parity /usr/bin/parity` 2. Copy release to bin folder, write `sudo install ./target/release/parity /usr/bin/parity`
3. To configure Open Ethereum, write a `/etc/parity/config.toml` config file, see [our old wiki](https://paritytech.github.io/wiki/Configuring-Parity) for details. 3. To configure OpenEthereum, see [our old wiki](https://paritytech.github.io/wiki/Configuring-Parity) for details.
## 4. Testing <a id="chapter-004"></a> ## 4. Testing <a id="chapter-004"></a>
@ -174,7 +181,7 @@ Replacing `<spec>` with one of the following from the details section below (i.e
**Package List** **Package List**
<details><p> <details><p>
* Open Ethereum (EthCore) Client Application * OpenEthereum Client Application
```bash ```bash
open-ethereum open-ethereum
``` ```
@ -203,11 +210,11 @@ Caching, Importing Blocks, and Block Information
```bash ```bash
ethcore-blockchain ethcore-blockchain
``` ```
* Open Ethereum (EthCore) Contract Calls and Blockchain Service & Registry Information * OpenEthereum Contract Calls and Blockchain Service & Registry Information
```bash ```bash
ethcore-call-contract ethcore-call-contract
``` ```
* Open Ethereum (EthCore) Database Access & Utilities, Database Cache Manager * OpenEthereum Database Access & Utilities, Database Cache Manager
```bash ```bash
ethcore-db ethcore-db
``` ```
@ -215,7 +222,7 @@ Caching, Importing Blocks, and Block Information
```bash ```bash
evm evm
``` ```
* Open Ethereum (EthCore) Light Client Implementation * OpenEthereum Light Client Implementation
```bash ```bash
ethcore-light ethcore-light
``` ```
@ -227,11 +234,11 @@ Caching, Importing Blocks, and Block Information
```bash ```bash
ethcore-private-tx ethcore-private-tx
``` ```
* Open Ethereum (EthCore) Client & Network Service Creation & Registration with the I/O Subsystem * OpenEthereum Client & Network Service Creation & Registration with the I/O Subsystem
```bash ```bash
ethcore-service ethcore-service
``` ```
* Open Ethereum (EthCore) Blockchain Synchronization * OpenEthereum Blockchain Synchronization
```bash ```bash
ethcore-sync ethcore-sync
``` ```
@ -263,11 +270,11 @@ Caching, Importing Blocks, and Block Information
```bash ```bash
parity-machine parity-machine
``` ```
* Open Ethereum (EthCore) Miner Interface * OpenEthereum Miner Interface
```bash ```bash
ethcore-miner parity-local-store price-info ethcore-stratum using_queue ethcore-miner parity-local-store price-info ethcore-stratum using_queue
``` ```
* Open Ethereum (EthCore) Logger Implementation * OpenEthereum Logger Implementation
```bash ```bash
ethcore-logger ethcore-logger
``` ```
@ -290,32 +297,6 @@ Caching, Importing Blocks, and Block Information
</p></details> </p></details>
### Contributing to documentation for Open Ethereum packages
[Document source code](https://doc.rust-lang.org/1.9.0/book/documentation.html) for Open Ethereum packages by annotating the source code with documentation comments.
Example (generic documentation comment):
```markdown
/// Summary
///
/// Description
///
/// # Panics
///
/// # Errors
///
/// # Safety
///
/// # Examples
///
/// Summary of Example 1
///
/// ```rust
/// // insert example 1 code here for use with documentation as tests
/// ```
///
```
## 6. Toolchain <a id="chapter-006"></a> ## 6. Toolchain <a id="chapter-006"></a>
In addition to the OpenEthereum client, there are additional tools in this repository available: In addition to the OpenEthereum client, there are additional tools in this repository available:
@ -324,18 +305,11 @@ In addition to the Open Ethereum client, there are additional tools in this repo
- [ethstore](./accounts/ethstore) - OpenEthereum Key Management. - [ethstore](./accounts/ethstore) - OpenEthereum Key Management.
- [ethkey](./accounts/ethkey) - OpenEthereum Keys Generator. - [ethkey](./accounts/ethkey) - OpenEthereum Keys Generator.
The following tool is available in a separate repository: The following tools are available in a separate repository:
- [ethabi](https://github.com/OpenEthereum/ethabi) - Open Ethereum Encoding of Function Calls. [Docs here](https://crates.io/crates/ethabi) - [ethabi](https://github.com/openethereum/ethabi) - OpenEthereum Encoding of Function Calls. [Docs here](https://crates.io/crates/ethabi)
- [whisper](https://github.com/OpenEthereum/whisper) - Open Ethereum Whisper-v2 PoC Implementation. - [whisper](https://github.com/openethereum/whisper) - OpenEthereum Whisper-v2 PoC Implementation.
## 7. Community <a id="chapter-007"></a> ## 7. Contributing <a id="chapter-007"></a>
### Join the chat!
Questions? Get in touch with us on Discord:
[![Discord: Open Ethereum](https://img.shields.io/discord/669192218728202270.svg?logo=discord)](https://discord.gg/FJUgGe)
## 8. Contributing <a id="chapter-008"></a>
An introduction has been provided in the ["So You Want to be a Core Developer" presentation slides by Hernando Castano](http://tiny.cc/contrib-to-parity-eth). Additional guidelines are provided in [CONTRIBUTING](./.github/CONTRIBUTING.md). An introduction has been provided in the ["So You Want to be a Core Developer" presentation slides by Hernando Castano](http://tiny.cc/contrib-to-parity-eth). Additional guidelines are provided in [CONTRIBUTING](./.github/CONTRIBUTING.md).
@ -343,6 +317,6 @@ An introduction has been provided in the ["So You Want to be a Core Developer" p
[CODE_OF_CONDUCT](./.github/CODE_OF_CONDUCT.md) [CODE_OF_CONDUCT](./.github/CODE_OF_CONDUCT.md)
## 9. License <a id="chapter-009"></a> ## 8. License <a id="chapter-008"></a>
[LICENSE](./LICENSE) [LICENSE](./LICENSE)