Skip to content

Commit

Permalink
Make Install docs by OS much more clear (MystenLabs#3403)
Browse files Browse the repository at this point in the history
* Move Rust and Cargo removal to Warning in Install docs for clarity

* Fix uninstall command

* Build out software requirements table

* Finish this round of improvements to install docs

* Make table header more clear

* Fix links into OS sections

* Make chronology more clear

* Update install.md

making the X center aligned in the cells

* Update install.md

adding a link to a URL

* Update install.md

additional link to a URL

* Update install.md

removing the links I added last night since core Markdown hyperlinks automatically

Co-authored-by: Randall DuBois <[email protected]>
  • Loading branch information
Clay-Mysten and randall-Mysten authored Jul 22, 2022
1 parent c532036 commit 8fc82cc
Showing 1 changed file with 64 additions and 24 deletions.
88 changes: 64 additions & 24 deletions doc/src/build/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,26 +33,52 @@ To immediately get started using Sui:
The following operating systems (OSes) have been tested and are supported for
running Sui:
* Linux - Ubuntu version 18.04 (Bionic Beaver)
* macOS - macOS Monterey
* Microsoft Windows - Windows 11
* [Linux](#linux-specific) - Ubuntu version 18.04 (Bionic Beaver)
* [macOS](#macOS-specific) - macOS Monterey
* [Microsoft Windows](#microsoft-windows-specific) - Windows 11
First install the [General packages](#general-packages) (plus [Brew](#brew) if on macOS), then install the OS-specific packages.
## Prerequisites
At a minimum, you should have a machine capable of installing command line tools (namely, a terminal).
First install the packages outlined this section. Then add the additional dependencies
below for your operating system.
Here are the packages required by operating system:
|Package/OS |Linux | macOS| Windows 11|
--- | :---: | :---:| :---:|
|Curl|X|X|X|
|Rust|X|X|X|
|Git CLI|X|X|X|
|CMake|X|X|X|
|libssl-dev|X| | |
|libclang-dev|X| | |
|Brew| |X| |
|C++ build tools| | |X|
|LLVM Compiler| | |X|
|Sui|X|X|X|
Follow the instructions below to install them. Then install the Sui [binaries](#binaries).
Finally, if you will be altering Sui itself, also obtain the [Sui source code](#source-code).
For simplicity, we recommend installing in `~/sui` or using an environment variable.
>**Important:** You will need to restart your command prompt after installing these prerequisites
>for them to be available in your environment.
### Sui binaries
Install the Sui [binaries](#binaries) as described below.
### Brew
In macOS, first install [Brew](https://brew.sh/) to install other packages:
```shell
$ /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
```
### Curl
### General packages
Ensure each of the packages below exist on each OS:
#### Curl
Confirm that you can run the `curl` command to download dependencies.
See whether you already have curl installed by running:
Expand All @@ -63,11 +89,20 @@ $ which curl
And if you see no output path, install it with:
*Linux*
```shell
$ sudo apt install curl
```
### Rust
*macOS*
```shell
$ sudo brew install curl
```
*Microsoft Windows*
Download and install from: https://curl.se/windows/
#### Rust
Sui is written in Rust, and we are using the latest version of the
[Cargo](https://doc.rust-lang.org/cargo/getting-started/installation.html) toolchain
to build and manage the dependencies. You will need Cargo to build and install Sui on your machine.
Expand All @@ -85,35 +120,40 @@ Then update the packages with:
$ rustup update stable
```
If you run into issues, re-install Rust and Cargo:
```shell
$ sudo apt remove cargo
sudo apt autoremove
```
And then start the Rust install over.
For more details, see:
https://www.rust-lang.org/tools/install
> **Warning:** If you run into issues, you may un-install Rust and Cargo with:
> ```shell
> $ rustup self uninstall
> ```
> And then start the Rust install over.
> For more details, see:
> https://www.rust-lang.org/tools/install
### Git CLI
#### Git CLI
Download and install the [`git` command line interface](https://git-scm.com/download/)
for your operating system.
### CMake
#### CMake
Get the `cmake` command to build Sui:
*Linux*
```shell
$ sudo apt install cmake
```
*macOS*
```shell
$ sudo brew install cmake
```
*Microsoft Windows*
Download and install from: https://cmake.org/download/
If you run into issues, follow this detailed [CMake Installation](https://riptutorial.com/cmake/example/4459/cmake-installation) tutorial.
### Linux
### Linux-specific
In Linux, also install:
In Linux, install:
libssl-dev
```shell
Expand All @@ -125,11 +165,11 @@ libclang-dev
$ sudo apt install libclang-dev
```
### macOS
### macOS-specific
In macOS, the general prerequisites outlined above are sufficient.
In macOS, other than the aforementioned [Brew](#brew) package manager, the general prerequisites are sufficient.
### Microsoft Windows
### Microsoft Windows-specific
In Microsoft Windows, also install:
Expand Down

0 comments on commit 8fc82cc

Please sign in to comment.