From a9aa0f7de509ffb5a6e1db82dd14868a042a3509 Mon Sep 17 00:00:00 2001 From: mario4tier Date: Tue, 15 Oct 2024 20:13:38 -0400 Subject: [PATCH] Simplify installation steps --- docs/src/how-to/install.md | 26 +++++--------------------- 1 file changed, 5 insertions(+), 21 deletions(-) diff --git a/docs/src/how-to/install.md b/docs/src/how-to/install.md index 554b59ab..a3b8f240 100644 --- a/docs/src/how-to/install.md +++ b/docs/src/how-to/install.md @@ -5,38 +5,22 @@ order: 1 ## Requirements **Supported operating systems** - * Linux >=20.04 (Arch and Ubuntu tested) + * Linux Ubuntu >=20.04 recommended (works also on Arch Linux) * macOS Monterey or later (Intel and Apple CPU) * Windows 10/11 with WSL2 - -**Prerequisites (Mandatory)** +**Prerequisites** - [cURL](https://curl.se) - [git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) - -**Prerequisites (Optional)** -Only if you disable precompiled binaries: - - [Mysten Labs build prerequisites](https://docs.sui.io/build/install#prerequisites). - -Only if you use Typescript related features: - - [Node.js](https://nodejs.org/en/download/package-manager) (>=20) - - [pnpm](https://pnpm.io/installation) (>=9) - -Note: Suibase nicely informs you of missing dependencies as you start to interact with a feature. - - ## Installation Steps ```shell $ cd ~ $ git clone https://github.com/chainmovers/suibase.git -$ cd suibase -$ ./install +$ ~/suibase/install ``` -Suibase is not intrusive on your system: - -- All its files and workdirs are in ```~/suibase``` and ```~/.local/bin``` -- Requires ```~/.local/bin``` to be in the [PATH](https://unix.stackexchange.com/questions/26047/how-to-correctly-add-a-path-to-path) env variable (you might have to add it manually). +- All Suibase files are created in ```~/suibase``` and ```~/.local/bin``` +- ```~/.local/bin``` must be listed in the PATH env variable ( on some setup you may have to [add it manually](https://unix.stackexchange.com/questions/26047/how-to-correctly-add-a-path-to-path) ).