mirror/erigon-pulse
1
0
Fork 0
mirror of https://gitlab.com/pulsechaincom/erigon-pulse.git synced 2024-12-22 03:30:37 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update README.md (#5153)

Browse Source 
Updated the "getting started" instructions to direct normal users to building the latest alpha release (rather than devel).

A similar change was previously made to the README.md in the alpha branch only. However, since the git repo defaults to the devel branch, most users will still see the README.md in the devel branch first. This may inadvertently guide new users to build the devel branch. Hence the change to the README.md in the devel branch.

An alternative option would be to default the git repo to the alpha branch, rather than the devel branch.
This commit is contained in:
Reinhard Schu 2022-08-23 13:59:34 +01:00 committed by GitHub
parent 69fbfc9bef
commit bebf4a0399
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -69,9 +69,21 @@ Usage
### Getting Started
For building the latest alpha release (this will be suitable for most users just wanting to run a node):
```sh
git clone --recurse-submodules -j8 https://github.com/ledgerwatch/erigon.git
git clone https://github.com/ledgerwatch/erigon.git
cd erigon
git checkout alpha
make erigon
./build/bin/erigon
```
You can check [the list of releases](https://github.com/ledgerwatch/erigon/releases) for release notes.
For building the bleeding edge development branch:
```sh
git clone --recurse-submodules https://github.com/ledgerwatch/erigon.git
cd erigon
git checkout devel
make erigon
./build/bin/erigon
```