Skip to content

Commit

Permalink
improve install
Browse files Browse the repository at this point in the history
  • Loading branch information
xhliu committed Mar 27, 2024
1 parent bfb0b41 commit 77b8b96
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 15 deletions.
25 changes: 10 additions & 15 deletions docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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.
:::
5 changes: 5 additions & 0 deletions yarn.lock
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down

0 comments on commit 77b8b96

Please sign in to comment.