From 77b8b969ffd0db99666fce663fb3db3bad532424 Mon Sep 17 00:00:00 2001 From: Xiaohui Date: Tue, 26 Mar 2024 17:29:55 -0700 Subject: [PATCH] improve install --- docs/installation.md | 25 ++++++++++--------------- yarn.lock | 5 +++++ 2 files changed, 15 insertions(+), 15 deletions(-) diff --git a/docs/installation.md b/docs/installation.md index bc3d90ad9..d54516b3a 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -6,31 +6,20 @@ sidebar_position: 2 ## Prerequisite -1. Install `Node.js` and `NPM` on your machine by following the instructions over [here](https://nodejs.org/en/download). +1. Install `Node.js` (require version `>=16`) and `NPM` on your machine by following the instructions over [here](https://nodejs.org/en/download). -:::note -Require `Node.js` version `>=16`. -::: + +2. Install [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git). :::note -If you are using mac computers with apple silicon, make sure [Rosetta](https://support.apple.com/en-us/102527) was installed with following command. +On Mac computers with Apple silicon like M1/M2, make sure [Rosetta](https://support.apple.com/en-us/102527) is installed. If not, it can be installed with the following command. ::: - ```bash softwareupdate --install-rosetta --agree-to-license ``` -2. Install [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git). - -3. Next, install the scrypt cli - -```sh -npm install -g scrypt-cli -``` -This will install the scrypt cli globally to your machine, after which you can create scrypt projects. - ## The sCrypt CLI Tool @@ -42,6 +31,12 @@ We can run the CLI tool directly with `npx` and try it out by creating a demo pr npx scrypt-cli project demo ``` +Or you can install it globally to your machine. + +```sh +npm install -g scrypt-cli +``` + :::tip You can also simply fork [the demo contract Repl](https://replit.com/@msinkec/scryptTS-demo) and play with the code in your browser. ::: diff --git a/yarn.lock b/yarn.lock index 6f6135262..6b03167a0 100644 --- a/yarn.lock +++ b/yarn.lock @@ -3955,6 +3955,11 @@ "resolved" "https://registry.npmjs.org/fs.realpath/-/fs.realpath-1.0.0.tgz" "version" "1.0.0" +"fsevents@~2.3.2": + "integrity" "sha512-xiqMQR4xAeHTuB9uWm+fFRcIOgKBMiOBP+eXiyT7jsgVCq1bkVygt00oASowB7EdtpOHaaPgKt812P9ab+DDKA==" + "resolved" "https://registry.npmjs.org/fsevents/-/fsevents-2.3.2.tgz" + "version" "2.3.2" + "function-bind@^1.1.1": "integrity" "sha512-yIovAzMX49sF8Yl58fSCWJ5svSLuaibPxXQJFLmBObTuCr0Mf1KiPopGM9NiFjiYBCbfaa2Fh6breQ6ANVTI0A==" "resolved" "https://registry.npmjs.org/function-bind/-/function-bind-1.1.1.tgz"