Skip to content

Commit

Permalink
Merge pull request #16 from gbdev/quickstart-readme
Browse files Browse the repository at this point in the history
Add quickstart description
  • Loading branch information
ZoomTen committed Feb 11, 2024
2 parents a75dc14 + abaae6b commit 210ac8f
Showing 1 changed file with 36 additions and 0 deletions.
36 changes: 36 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,42 @@ This is a version manager for [RGBDS](https://github.com/gbdev/rgbds). It is a p

\* Bash script, at the moment. Compatibility with other shells is not guaranteed.

## Quickstart (Debian)

### 1. Get rgbenv
```sh
sudo apt install -y libpng-dev pkg-config build-essential bison git curl
sudo curl -o /usr/local/bin/rgbenv https://raw.githubusercontent.com/gbdev/rgbenv/master/rgbenv
sudo chmod +x /usr/local/bin/rgbenv
```

### 2. Install a version and set it as the default
```sh
rgbenv install 0.7.0
rgbenv use 0.7.0
```

### 3. Use the default version
```sh
rgbenv exec rgbasm -V
```
(replace `rgbasm -V` with your desired command)

To use it without `rgbenv exec`
```sh
echo 'export PATH="$HOME/.local/share/rgbenv/default/bin:$PATH"' >> .bashrc
source .bashrc
rgbasm -V
```

### 4. Execute with another version
```sh
rgbenv install 0.6.1
rgbenv exec -v 0.6.1 rgbasm -V
```
(replace `rgbasm -V` with your desired command)


## What does it do?

* Installs or uninstalls a specific version of the RGBDS suite.
Expand Down

0 comments on commit 210ac8f

Please sign in to comment.