Skip to content

Commit 1b000f3

Browse files
committed
Remove console prompts from shell commands so they don't get copy+pasted
Also make some list formatting more consistent
1 parent 1bea92e commit 1b000f3

File tree

4 files changed

+24
-18
lines changed

4 files changed

+24
-18
lines changed

install/linux.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,15 @@ If a satisfactory version is available, it is a good idea to install from there.
1111

1212
## Using our pre-built binaries
1313

14-
1. Download the [latest release of `rgbds-linux-x86_64.tar.xz`](https://github.com/gbdev/rgbds/releases/latest/download/rgbds-linux-x86_64.tar.xz). (Or pick [a specific version](https://github.com/gbdev/rgbds/releases) and download it under "Assets" at the bottom.)
15-
2. Extract the downloaded `rgbds-linux-x86_64.tar.xz` file into a new directory, and run `install.sh` as root in that directory. For example:
16-
```console
17-
% mkdir rgbds
18-
% tar xf rgbds-linux-x86_64.tar.xz -C rgbds
19-
% cd rgbds
20-
% sudo ./install.sh
14+
1. Download the [latest release of `rgbds-linux-x86_64.tar.xz`](https://github.com/gbdev/rgbds/releases/latest/download/rgbds-linux-x86_64.tar.xz).
15+
(Or pick [a specific version](https://github.com/gbdev/rgbds/releases) and download it under "Assets" at the bottom.)
16+
2. Extract the downloaded `rgbds-linux-x86_64.tar.xz` file into a new directory, and run `install.sh` as root in that directory.
17+
For example, you can do that with these shell commands:
18+
```bash
19+
mkdir rgbds
20+
tar xf rgbds-linux-x86_64.tar.xz -C rgbds
21+
cd rgbds
22+
sudo ./install.sh
2123
```
2224
3. Check that RGBDS was correctly installed by running `rgbasm -V`.
2325
It should print out the version number you installed!

install/macos.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -21,16 +21,16 @@ brew install rgbds --HEAD
2121

2222
## Using our pre-built binaries
2323

24-
1. Download the [latest release of `rgbds-macos.zip`](https://github.com/gbdev/rgbds/releases/latest/download/rgbds-macos.zip). (Or pick [a specific version](https://github.com/gbdev/rgbds/releases) and download it under "Assets" at the bottom.)
25-
26-
3. Extract the downloaded `rgbds-macos.zip` file into a new directory, and run `install.sh` as root inside that directory.
24+
1. Download the [latest release of `rgbds-macos.zip`](https://github.com/gbdev/rgbds/releases/latest/download/rgbds-macos.zip).
25+
(Or pick [a specific version](https://github.com/gbdev/rgbds/releases) and download it under "Assets" at the bottom.)
26+
2. Extract the downloaded `rgbds-macos.zip` file into a new directory, and run `install.sh` as root inside that directory.
2727
For example, you can do that with these Console commands:
28-
```console
29-
% unzip -d rgbds rgbds-macos.zip
30-
% cd rgbds
31-
% sudo ./install.sh
28+
```zsh
29+
unzip -d rgbds rgbds-macos.zip
30+
cd rgbds
31+
sudo ./install.sh
3232
```
33-
4. Check that RGBDS was correctly installed by running `rgbasm -V`.
33+
3. Check that RGBDS was correctly installed by running `rgbasm -V`.
3434
It should print out the version number you installed!
3535

3636
---

install/source.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,9 @@ You first need to get the source files to be compiled, using one of the methods
2323
<Tabs>
2424
<TabItem value="snapshot" label="Downloading source snapshots">
2525

26-
1. Download the [latest release of `rgbds-source.tar.gz`](https://github.com/gbdev/rgbds/releases/latest/download/rgbds-source.tar.gz). (Or pick [a specific version](https://github.com/gbdev/rgbds/releases) and download it under "Assets" at the bottom.) (The "Source code (`zip`)" or "Source code (`tar.gz`)" links will also work.)
26+
1. Download the [latest release of `rgbds-source.tar.gz`](https://github.com/gbdev/rgbds/releases/latest/download/rgbds-source.tar.gz).
27+
(Or pick [a specific version](https://github.com/gbdev/rgbds/releases) and download it under "Assets" at the bottom.)
28+
(The "Source code (`zip`)" or "Source code (`tar.gz`)" links will also work.)
2729
2. Extract ("unzip") the file.
2830

2931
</TabItem>

install/windows.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,8 @@ You can check what your WSL distribution is by running `wsl -l -v` in the Comman
2121
</TabItem>
2222
<TabItem value="cygwin" label="Cygwin / MSYS2">
2323

24-
1. Download the latest release of either [`rgbds-win64.zip`](https://github.com/gbdev/rgbds/releases/latest/download/rgbds-win64.zip) (for 64-bit Windows) or [`rgbds-win32.zip`](https://github.com/gbdev/rgbds/releases/latest/download/rgbds-win32.zip) (for 32-bit Windows). (Or pick [a specific version](https://github.com/gbdev/rgbds/releases) and download it under "Assets" at the bottom.)
24+
1. Download the latest release of either [`rgbds-win64.zip`](https://github.com/gbdev/rgbds/releases/latest/download/rgbds-win64.zip) (for 64-bit Windows) or [`rgbds-win32.zip`](https://github.com/gbdev/rgbds/releases/latest/download/rgbds-win32.zip) (for 32-bit Windows).
25+
(Or pick [a specific version](https://github.com/gbdev/rgbds/releases) and download it under "Assets" at the bottom.)
2526
2. Unzip the downloaded `.zip` file.
2627
It should give you four `.exe` files and a couple of `.dll` files.
2728
3. Copy all of those `.exe` and `.dll` files to the `/usr/local/bin` directory of your Cygwin/MSYS2 installation.
@@ -48,7 +49,8 @@ If you can choose between using Cygwin or MSYS2, be advised that Cygwin is slowe
4849
</TabItem>
4950
<TabItem value="win32" label="None of those">
5051

51-
1. Download the latest release of either [`rgbds-win64.zip`](https://github.com/gbdev/rgbds/releases/latest/download/rgbds-win64.zip) (for 64-bit Windows) or [`rgbds-win32.zip`](https://github.com/gbdev/rgbds/releases/latest/download/rgbds-win32.zip) (for 32-bit Windows). (Or pick [a specific version](https://github.com/gbdev/rgbds/releases) and download it under "Assets" at the bottom.)
52+
1. Download the latest release of either [`rgbds-win64.zip`](https://github.com/gbdev/rgbds/releases/latest/download/rgbds-win64.zip) (for 64-bit Windows) or [`rgbds-win32.zip`](https://github.com/gbdev/rgbds/releases/latest/download/rgbds-win32.zip) (for 32-bit Windows).
53+
(Or pick [a specific version](https://github.com/gbdev/rgbds/releases) and download it under "Assets" at the bottom.)
5254
2. Unzip the `.zip` file.
5355
It should give you four `.exe` files and a couple of `.dll` files.
5456
3. Either:

0 commit comments

Comments
 (0)