Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add quickstart description #16

Merged
merged 5 commits into from
Feb 11, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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)
ZoomTen marked this conversation as resolved.
Show resolved Hide resolved

### 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
ISSOtm marked this conversation as resolved.
Show resolved Hide resolved
```

### 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
Loading