Skip to content

Commit

Permalink
chore(docs): setup-dev improvements (matter-labs#836)
Browse files Browse the repository at this point in the history
## What ❔

Small improvements to setup-dev docs

## Why ❔

Eliminate steps which can be resulted in wrong versions of packages
installed

## Checklist

- [x] PR title corresponds to the body of PR (we generate changelog
entries from PRs).
- [ ] Tests for the changes have been added / updated.
- [x] Documentation comments have been added / updated.
- [x] Code has been formatted via `zk fmt` and `zk lint`.
- [ ] Spellcheck has been run via `cargo spellcheck
--cfg=./spellcheck/era.cfg --code 1`.
  • Loading branch information
artmakh authored Jan 8, 2024
1 parent 7d4a878 commit 83c1546
Showing 1 changed file with 21 additions and 11 deletions.
32 changes: 21 additions & 11 deletions docs/guides/setup-dev.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,14 @@ curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
# NVM
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.5/install.sh | bash
# All necessary stuff
sudo apt-get install build-essential pkg-config cmake clang lldb lld libssl-dev postgresql docker-compose
sudo apt-get install build-essential pkg-config cmake clang lldb lld libssl-dev postgresql
# Docker
sudo usermod -aG docker YOUR_USER

## You might need to re-connect (due to usermod change).

# Node & yarn
nvm install node
nvm install 18
npm install -g yarn
yarn set version 1.22.19

Expand Down Expand Up @@ -55,9 +55,9 @@ want to only have CLI tool, you need the `docker-ce` package and you can follow

Installing `docker` via `snap` or from the default repository can cause troubles.

You need to install both `docker` and `docker-compose`.
You need to install both `docker` and `docker compose`.

**Note:** `docker-compose` is installed automatically with `Docker Desktop`.
**Note:** `docker compose` is installed automatically with `Docker Desktop`.

**Note:** On linux you may encounter the following error when you’ll try to work with `zksync`:

Expand Down Expand Up @@ -90,10 +90,10 @@ If logging out does not resolve the issue, restarting the computer should.
`Node.js`, we suggest you to install [nvm](https://github.com/nvm-sh/nvm). It will allow you to update `Node.js`
version easily in the future (by running `nvm use` in the root of the repository)
2. Install `yarn` (make sure to get version 1.22.19 - you can change the version by running `yarn set version 1.22.19`).
Instructions can be found on the [official site](https://classic.yarnpkg.com/en/docs/install/).
Check if `yarn` is installed by running `yarn -v`. If you face any problems when installing `yarn`, it might be the
case that your package manager installed the wrong package.Make sure to thoroughly follow the instructions above on
the official website. It contains a lot of troubleshooting guides in it.
Instructions can be found on the [official site](https://classic.yarnpkg.com/en/docs/install/). Check if `yarn` is
installed by running `yarn -v`. If you face any problems when installing `yarn`, it might be the case that your
package manager installed the wrong package.Make sure to thoroughly follow the instructions above on the official
website. It contains a lot of troubleshooting guides in it.

## `Axel`

Expand Down Expand Up @@ -123,7 +123,7 @@ Make sure the version is higher than `2.17.10`.

In order to compile RocksDB, you must have LLVM available. On debian-based linux it can be installed as follows:

On linux:
On debian-based linux:

```bash
sudo apt-get install build-essential pkg-config cmake clang lldb lld
Expand All @@ -144,7 +144,7 @@ On mac:
brew install openssl
```

On linux:
On debian-based linux:

```bash
sudo apt-get install libssl-dev
Expand Down Expand Up @@ -196,7 +196,7 @@ On mac:
brew install postgresql@14
```

On linux:
On debian-based linux:

```bash
sudo apt-get install postgresql
Expand Down Expand Up @@ -224,10 +224,20 @@ cargo install sqlx-cli --version 0.7.3

Install the latest solidity compiler.

On mac:

```bash
brew install solidity
```

On debian-based linux:

```bash
sudo add-apt-repository ppa:ethereum/ethereum
sudo apt-get update
sudo apt-get install solc
```

Alternatively, download a [precompiled version](https://github.com/ethereum/solc-bin) and add it to your PATH.

## Python
Expand Down

0 comments on commit 83c1546

Please sign in to comment.