diff --git a/docs/the_nimbus_book/src/install.md b/docs/the_nimbus_book/src/install.md index 7f09fe767..f016c29cb 100644 --- a/docs/the_nimbus_book/src/install.md +++ b/docs/the_nimbus_book/src/install.md @@ -1,31 +1,31 @@ # Installation -The Beacon chain can run on Linux, macOS, Windows, and Android. At the moment, Nimbus has to be built from source. +The Nimbus beacon chain can run on Linux, macOS, Windows, and Android. At the moment, Nimbus has to be built from source. ## Time -The beacon chain relies on your computer having the correct time set, down to at most 0.5 seconds. +The beacon chain relies on your computer having the correct time set (plus or minus 0.5 seconds). We recommended you run a high quality time service on your computer such as: * GPS -* NTS (network time security, IETF draft) -* Roughtime (google) +* NTS (network time security, [IETF draft](https://tools.ietf.org/html/draft-ietf-ntp-using-nts-for-ntp-19)) +* [Roughtime](https://roughtime.googlesource.com/roughtime) (google) -As a minimum, you should run an NTP client on the server. +At a minimum, you should run an NTP client on the server. -If that makes no sense to you, don't worry. For testnets, just making sure your computer is set at the correct time should be fine. +If that sounds like latin to you, don't worry. For testnet purposes, you should be fine as long as your computer is set to the correct time. ## External Dependencies - Developer tools (C compiler, Make, Bash, Git) -- PCRE +- [PCRE](https://www.pcre.org/) -Nim is not an external dependency, Nimbus will build its own local copy. +Nimbus will build its own local copy of Nim, so Nim is not an external dependency, ## Linux -On common Linux distributions the dependencies can be installed with: +On common Linux distributions the dependencies can be installed with ```sh # Debian and Ubuntu @@ -49,15 +49,15 @@ brew install pcre cmake ### Windows You can install the developer tools by following the instruction in our [Windows dev environment section](./advanced.md#windows-dev-environment). -It also provides a downloading script for prebuilt PCRE. +We also provide a downloading script for prebuilt PCRE. ### Android - Install the [Termux](https://termux.com) app from FDroid or the Google Play store - Install a [PRoot](https://wiki.termux.com/wiki/PRoot) of your choice following the instructions for your preferred distribution. - Note, the Ubuntu PRoot is known to contain all Nimbus prerequisites compiled on Arm64 architecture (common architecture for Android devices). + Note, the Ubuntu PRoot is known to contain all Nimbus prerequisites compiled on Arm64 architecture (the most common architecture for Android devices). -_Assuming Ubuntu PRoot is used_ +Assuming you use Ubuntu PRoot ```sh apt install build-essential git libpcre3-dev @@ -65,4 +65,4 @@ apt install build-essential git libpcre3-dev ## Next steps -Once you've installed the prerequisites, you're ready to move on to [running a validator on Medalla](./medalla.md). +You're now ready to move on to [running a validator on Medalla](./medalla.md).