Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jakub-jedrusiak authored Oct 21, 2024
1 parent e5e8a7e commit c8f042a
Showing 1 changed file with 6 additions and 21 deletions.
27 changes: 6 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,29 +57,14 @@ You can install development version (unstable) with:
pip install velesresearch@git+https://github.com/jakub-jedrusiak/VelesResearch.git
```

Note that **`yarn` is required** for Veles to work. You can download it from [here](https://nodejs.org/en/download) or use your package manager.
Note that **`bun` is required** for Veles to work. Use one of the following commands to install it:

``` bash
# Ubuntu (and other apt distros)
sudo apt install npm
# Linux and MacOS
curl -fsSL https://bun.sh/install | bash

# Arch
sudo pacman -S npm

# winget
winget install OpenJS.NodeJS.LTS

# Chocolatey
choco install nodejs-lts

# Homebrew
brew install node
```

After installing `node.js`, activate `yarn` with this command in the terminal:

``` bash
corepack enable
# Windows
powershell -c "irm bun.sh/install.ps1|iex"
```

If everything went well, command `yarn -v` should return a version number.
If everything went well, command `bun --version` should return a version number. See [Getting started](getting-started.qmd) if you get any errors.

0 comments on commit c8f042a

Please sign in to comment.