Skip to content
This repository has been archived by the owner on Aug 2, 2022. It is now read-only.

Update EOSIO documentation (develop) #8369

Merged
merged 35 commits into from
Jan 27, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
35 commits
Select commit Hold shift + click to select a range
6481f0c
simplify build from source instructions
Dec 19, 2019
4a09e9e
remove old manual build instructions
Dec 19, 2019
5c4cc8d
add missing cleos get actions command
Dec 20, 2019
27c144e
minor edit on nodeos index
Dec 20, 2019
c1c686a
minor edits on cleos get account command
Dec 20, 2019
d82b60f
minor edits on shell script index
Dec 20, 2019
b3696fb
fix links in main docs folder
Dec 20, 2019
c83920f
minor edits on install script
Dec 20, 2019
9dca33a
move upgrade guides from troubleshooting to its own folder
Dec 20, 2019
90ebfff
remove blank index from cleos command reference
Dec 20, 2019
8229a5e
add content_title to nodeos, cleos, keosd where applicable
Dec 20, 2019
569ee0a
Merge branch 'develop' into docs/develop-main
Dec 20, 2019
e4b8a33
fix script uninstall link on callout
Dec 23, 2019
fd9dfbe
Merge branch 'develop' into docs/develop-main
Dec 23, 2019
09f95ce
remove redundant install eosio callout
Dec 24, 2019
ba40ca1
fix install location of prebuilt binaries
Jan 8, 2020
beebea7
add official support callout in install index
Jan 9, 2020
a9a49ae
minor edit on install prebuilt binaries doc
Jan 9, 2020
d3f2612
replace/move down duplicate license in README
Jan 8, 2020
61513af
rewrite (friendlier) software install section in README
Jan 9, 2020
b705d69
minor edit on install prebuilt binaries section in README
Jan 9, 2020
f93da05
Link corrections and new section
dskvr Jan 9, 2020
a4879b8
Remove shell scripts section from README
dskvr Jan 9, 2020
00b7fcd
hotfix documentation links
dskvr Jan 11, 2020
c556941
Merge branch 'develop' into docs/develop-main
Jan 14, 2020
ac73fed
Merge branch 'develop' into docs/develop-main
Jan 24, 2020
7560e74
remove outdated js example and protocol from state history plugin
Jan 24, 2020
aced713
fix typo in how to from state history plugin
Jan 25, 2020
7164c34
add custom titles to how-tos from state history plugin
Jan 25, 2020
5a9738f
fix link and remove option from replay how to from state history
Jan 25, 2020
47712e7
Revert "fix link and remove option from replay how to from state hist…
Jan 26, 2020
f76579b
Revert "add custom titles to how-tos from state history plugin"
Jan 26, 2020
e09ed41
Revert "fix typo in how to from state history plugin"
Jan 26, 2020
33e8f5b
Revert "remove outdated js example and protocol from state history pl…
Jan 26, 2020
30395ab
add platforms folder containing manual build instructions
Dec 23, 2019
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 12 additions & 3 deletions docs/00_install/00_install-prebuilt-binaries.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
---
content_title: Install Prebuilt Binaries
---

[[info | Previous Builds]]
| If you have previously installed EOSIO from source using shell scripts, you must first run the [Uninstall Script](01_build-from-source/05_uninstall-eosio.md) before installing any prebuilt binaries on the same OS.
| If you have previously installed EOSIO from source using shell scripts, you must first run the [Uninstall Script](01_build-from-source/01_shell-scripts/05_uninstall-eosio.md) before installing any prebuilt binaries on the same OS.

## Prebuilt Binaries

EOSIO prebuilt binary packages are available for specific [Operating Systems](index.md#supported-operating-systems). Find the instructions below for your given OS:
Prebuilt EOSIO software packages are available for the operating systems below. Find and follow the instructions for your OS:

### Mac OS X:

Expand Down Expand Up @@ -49,7 +52,13 @@ $ sudo yum remove eosio

## Location of EOSIO binaries

After installing the prebuilt binaries, the actual EOSIO binaries will be located under the `~/eosio/x.y/bin` folder, where `x.y` is the EOSIO release version that was installed.
After installing the prebuilt packages, the actual EOSIO binaries will be located under:
* `/usr/opt/eosio/<version-string>/bin` (Linux-based); or
* `/usr/local/Cellar/eosio/<version-string>/bin` (MacOS )

where `version-string` is the EOSIO version that was installed; e.g. `2.0.0-rc2`.

Also, soft links for each EOSIO program (`nodeos`, `cleos`, `keosd`, etc.) will be created under `usr/bin` or `usr/local/bin` to allow them to be executed from any directory.

## Previous Versions

Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
---
content_title: Download EOSIO Source
---

To download the EOSIO source code, clone the `eos` repo and its submodules. It is adviced to create a home `eosio` folder first and download all the EOSIO related software there:

Expand All @@ -23,3 +26,6 @@ When pulling changes, especially after switching branches, the submodules *must*
$ [git checkout <branch>] (optional)
$ git pull --recurse-submodules
```

[[info | What's Next?]]
| [Build EOSIO binaries](02_build-eosio-binaries.md)
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
---
content_title: Build EOSIO Binaries
---

[[info | Shell Scripts]]
| The build script is one of various automated shell scripts provided in the EOSIO repository for building, installing, and optionally uninstalling the EOSIO software and its dependencies. They are available in the `eos/scripts` folder.
Expand All @@ -12,4 +15,4 @@ $ ./scripts/eosio_build.sh
The build process writes temporary content to the `eos/build` folder. After building, the program binaries can be found at `eos/build/programs`.

[[info | What's Next?]]
| [Install EOSIO binaries](../03_install-eosio-binaries.md)
| [Installing EOSIO](03_install-eosio-binaries.md) is strongly recommended after building from source as it makes local development significantly more friendly.
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
---
content_title: Install EOSIO Binaries
---

## EOSIO install script

Expand All @@ -16,3 +19,6 @@ In lieu of the `eosio_install.sh` script, you can install the EOSIO binaries dir
$ cd ~/eosio/eos/build
$ sudo make install
```

[[info | What's Next?]]
| Configure and use [Nodeos](../../../01_nodeos/index.md), or optionally [Test the EOSIO binaries](04_test-eosio-binaries.md).
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
---
content_title: Test EOSIO Binaries
---

Optionally, a set of tests can be run against your build to perform some basic validation of the EOSIO software installation.

Expand Down Expand Up @@ -25,5 +28,5 @@ cd ~/eosio/eos/build
make test
```

[[info | Recommend]]
| It is strongly suggested to [Install the EOSIO binaries](03_install-eosio-binaries.md) after building EOSIO from source as it makes local development significantly more friendly.
[[info | What's Next?]]
| Configure and use [Nodeos](../../../01_nodeos/index.md).
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
---
content_title: Uninstall EOSIO
---

If you have previously built EOSIO from source and now wish to install the prebuilt binaries, or to build from source again, it is recommended to run the `eosio_uninstall.sh` script within the `eos/scripts` folder:

Expand Down
17 changes: 17 additions & 0 deletions docs/00_install/01_build-from-source/01_shell-scripts/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
content_title: Shell Scripts
---

[[info | Did you know?]]
| Shell scripts automate the process of building, installing, testing, and uninstalling the EOSIO software and dependencies.

To build EOSIO from the source code using shell scripts, visit the sections below:

1. [Download EOSIO Source](01_download-eosio-source.md)
2. [Build EOSIO Binaries](02_build-eosio-binaries.md)
3. [Install EOSIO Binaries](03_install-eosio-binaries.md)
4. [Test EOSIO Binaries](04_test-eosio-binaries.md)
5. [Uninstall EOSIO](05_uninstall-eosio.md)

[[info | Building EOSIO is for Advanced Developers]]
| If you are new to EOSIO, it is recommended that you install the [EOSIO Prebuilt Binaries](../../00_install-prebuilt-binaries.md) instead of building from source.

This file was deleted.

Loading