status-im
/
nimbus-eth1
mirror of https://github.com/status-im/nimbus-eth1.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

Add monthly development updates link (#776) 

* Update readme with adjusted intro and dev updates link

* Remove pcre from prerequisites as it no longer is

* Change to hackmd doc as status notes seem not accessible
This commit is contained in:
Kim De Mey 2021-08-09 16:10:58 +02:00 committed by GitHub
parent 77092641b5
commit a05f366ca2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 23 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
README.md
View File

@ -10,13 +10,25 @@
[![Gitter: #status-im/nimbus](https://img.shields.io/badge/gitter-status--im%2Fnimbus-orange.svg)](https://gitter.im/status-im/nimbus)
[![Status: #nimbus-general](https://img.shields.io/badge/status-nimbus--general-orange.svg)](https://get.status.im/chat/public/nimbus-general)
## Rationale
## Introduction
[Nimbus: an Ethereum 2.0 Sharding Client](https://our.status.im/nimbus-for-newbies/). The code in this repository is currently focusing on Ethereum 1.0 feature parity, while all 2.0 research and development is happening in parallel in [nimbus-eth2](https://github.com/status-im/nimbus-eth2).
The code in this repository is focusing on Ethereum 1.0 feature parity,
and Ethereum 1.x research & development.
This repository is also home to [fluffy](./fluffy/README.md), a
[Portal Network](https://github.com/ethereum/stateless-ethereum-specs/blob/master/portal-network.md)
light client.
All Ethereum 2.0 research and development is happening in parallel in the
[nimbus-eth2](https://github.com/status-im/nimbus-eth2) repository.
## Development Updates
To keep up to date with changes and development progress, follow the [Nimbus blog](https://our.status.im/tag/nimbus/).
Monthly development updates are shared
[here](https://hackmd.io/jRpxY4WBQJ-hnsKaPDYqTw).
For more detailed write-ups on the development progress, follow the
[Nimbus blog](https://our.status.im/tag/nimbus/).
## Building & Testing
@ -25,23 +37,22 @@ _We currently do not guarantee that Nimbus will work on Windows._
### Prerequisites
* [RocksDB](https://github.com/facebook/rocksdb/)
* PCRE
* GNU Make, Bash and the usual POSIX utilities. Git 2.9.4 or newer.
On Windows, a precompiled DLL collection download is available through the `fetch-dlls` Makefile target: ([Windows instructions](#windows)).
```bash
# MacOS with Homebrew
brew install rocksdb pcre
brew install rocksdb
# Fedora
dnf install rocksdb-devel pcre pcre-devel
dnf install rocksdb-devel
# Debian and Ubuntu
sudo apt-get install librocksdb-dev libpcre3-dev
sudo apt-get install librocksdb-dev
# Arch (AUR)
pakku -S rocksdb pcre-static
pakku -S rocksdb
```
`rocksdb` can also be installed by following [their instructions](https://github.com/facebook/rocksdb/blob/master/INSTALL.md).
@ -176,7 +187,7 @@ Note, the Ubuntu PRoot is known to contain all Nimbus prerequisites compiled on
```bash
# Install prerequisites
apt install librocksdb-dev libpcre3-dev
apt install librocksdb-dev
# Clone repo and build Nimbus just like above
git clone https://github.com/status-im/nimbus.git

6
fluffy/README.md
View File

@ -1,4 +1,4 @@
# Nimbus Light Portal Network Client
# Fluffy: The Nimbus Portal Network Client
[![fluffy CI](https://github.com/status-im/nimbus-eth1/actions/workflows/fluffy.yml/badge.svg)](https://github.com/status-im/nimbus-eth1/actions/workflows/fluffy.yml)
![Stability: experimental](https://img.shields.io/badge/stability-experimental-orange.svg)
@ -10,8 +10,8 @@
## Introduction
This folder holds the development of the Nimbus client implementation supporting
the Portal Network. The Portal Network is a project still heavily in research
phase and fully in flux. This client is thus still highly experimental.
the Portal Network: fluffy. The Portal Network is a project still heavily in
research phase and fully in flux. This client is thus still highly experimental.
Current status of specifications can be found in the
[stateless-ethereum-specs repository](https://github.com/ethereum/stateless-ethereum-specs/blob/master/portal-network.md).