Skip to content

Commit 5d5caaf

Browse files
authored
Omit the version number from distributed release archive filenames (#78)
1 parent 0a286b6 commit 5d5caaf

4 files changed

Lines changed: 21 additions & 27 deletions

File tree

install/linux.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,16 +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. Go the [latest release](https://github.com/gbdev/rgbds/releases/latest) (or pick [a specific version](https://github.com/gbdev/rgbds/releases))
15-
2. Under "Assets" at the bottom, download <code>rgbds-<var>&lt;version&gt;</var>-linux-x86_64.tar.xz</code> (for example, version 0.7.0 would have `rgbds-0.7.0-linux-x86_64.tar.xz`)
16-
3. Extract the .tar.xz file into a new directory, and run `install.sh` as root in that directory. E.g.:
14+
1. Download the [latest release of `rgbds-linux-x86_64.tar.xz`](https://github.com/gbdev/rgbds/releases/download/latest/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:
1716
```console
1817
% mkdir rgbds
19-
% tar xf rgbds-0.7.0-linux-x86_64.tar.xz -C rgbds
18+
% tar xf rgbds-linux-x86_64.tar.xz -C rgbds
2019
% cd rgbds
2120
% sudo ./install.sh
2221
```
23-
4. Check that RGBDS was correctly installed by running `rgbasm -V`.
22+
3. Check that RGBDS was correctly installed by running `rgbasm -V`.
2423
It should print out the version number you installed!
2524

2625
---

install/macos.md

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

2222
## Using our pre-built binaries
2323

24-
1. Go the [latest release](https://github.com/gbdev/rgbds/releases/latest) (or pick [a specific version](https://github.com/gbdev/rgbds/releases))
25-
2. Under "Assets" at the bottom, download <code>rgbds-<var>&lt;version&gt;</var>-macos-x86-64.zip</code> (for example, version 0.7.0 would have `rgbds-0.7.0-macos-x86-64.zip`).
26-
3. Extract the .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/download/latest/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.
2727
For example, you can do that with these Console commands:
2828
```console
29-
% unzip -d rgbds rgbds-0.7.0-macos-x86-64.zip
29+
% unzip -d rgbds rgbds-macos.zip
3030
% cd rgbds
3131
% sudo ./install.sh
3232
```

install/source.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,15 +23,14 @@ 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. Go the [latest release](https://github.com/gbdev/rgbds/releases/latest) (or pick [a specific version](https://github.com/gbdev/rgbds/releases))
27-
2. Under "Assets" at the bottom, download any of the last three listed files (<code>rgbds-<var>&lt;version&gt;</var>.tar.gz</code>, "Source code (`zip`)", or "Source code (`tar.gz`)").
28-
3. Extract ("unzip") the file.
26+
1. Download the [latest release of `rgbds-source.tar.gz`](https://github.com/gbdev/rgbds/releases/download/latest/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.)
27+
2. Extract ("unzip") the file.
2928

3029
</TabItem>
3130
<TabItem value="git" label="Using Git">
3231

3332
1. [Clone the repository](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository).
34-
2. Then, run `git checkout <version>` (e.g. `git checkout v0.4.1`).
33+
2. Then, run `git checkout <version>` (e.g. `git checkout v0.9.3`).
3534
3. You're set!
3635

3736
</TabItem>

install/windows.md

Lines changed: 10 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,10 @@ 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. Go the [latest release](https://github.com/gbdev/rgbds/releases/latest) (or pick a specific version from [the list](https://github.com/gbdev/rgbds/releases)).
25-
2. Under "Assets" at the bottom, download either <code>rgbds-<var>&lt;version&gt;</var>-win32.zip</code> (for 32-bit Windows) or <code>rgbds-<var>&lt;version&gt;</var>-win64.zip</code> (for 64-bit Windows).
26-
(For example, version 0.7.0 for 64-bit Windows would have `rgbds-0.7.0-win64.zip`).
27-
3. Unzip the .zip file.
24+
1. Download the latest release of either [`rgbds-win64.zip`](https://github.com/gbdev/rgbds/releases/download/latest/rgbds-win64.zip) (for 64-bit Windows) or [`rgbds-win32.zip`](https://github.com/gbdev/rgbds/releases/download/latest/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.)
25+
2. Unzip the downloaded `.zip` file.
2826
It should give you four `.exe` files and a couple of `.dll` files.
29-
4. Copy all of those `.exe` and `.dll` files to the `/usr/local/bin` directory of your Cygwin/MSYS2 installation.
27+
3. Copy all of those `.exe` and `.dll` files to the `/usr/local/bin` directory of your Cygwin/MSYS2 installation.
3028
(You can learn its equivalent Windows path by running `cygpath -w /usr/local/bin` in the Cygwin terminal.)
3129

3230
:::caution
@@ -50,12 +48,10 @@ If you can choose between using Cygwin or MSYS2, be advised that Cygwin is slowe
5048
</TabItem>
5149
<TabItem value="win32" label="None of those">
5250

53-
1. Go the [latest release](https://github.com/gbdev/rgbds/releases/latest) (or pick a specific version from [the list](https://github.com/gbdev/rgbds/releases))
54-
2. Under "Assets" at the bottom, download either <code>rgbds-<var>&lt;version&gt;</var>-win32.zip</code> (for 32-bit Windows) or <code>rgbds-<var>&lt;version&gt;</var>-win64.zip</code> (for 64-bit Windows).
55-
(For example, version 0.7.0 for 64-bit Windows would have `rgbds-0.7.0-win64.zip`).
56-
3. Unzip the .zip file.
51+
1. Download the latest release of either [`rgbds-win64.zip`](https://github.com/gbdev/rgbds/releases/download/latest/rgbds-win64.zip) (for 64-bit Windows) or [`rgbds-win32.zip`](https://github.com/gbdev/rgbds/releases/download/latest/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+
2. Unzip the `.zip` file.
5753
It should give you four `.exe` files and a couple of `.dll` files.
58-
4. Either:
54+
3. Either:
5955
- ...put all of the files in a directory, then add that directory to Windows' `PATH`.
6056
This will *permanently* allow you to use RGBDS *from any directory*.
6157

@@ -67,11 +63,11 @@ If you can choose between using Cygwin or MSYS2, be advised that Cygwin is slowe
6763
- ...typing "edit environment variables for your account" in the Start menu's Search box and clicking the Control Panel item that's found.
6864
- ...opening the Control Panel, clicking its "User Accounts" item, clicking the "User Accounts" heading in that item, and clicking "Change my environment variables" in the sidebar.
6965
2. Click the "Path" line in the **top** panel to highlight it.
70-
6. Click "Edit..." to open the "Edit environment variable" dialog for "Path".
71-
7. Click "Browse...", select the folder that the RGBDS files are in, and click OK.
72-
8. The folder should be added to the bottom of the "Path" list.
66+
3. Click "Edit..." to open the "Edit environment variable" dialog for "Path".
67+
4. Click "Browse...", select the folder that the RGBDS files are in, and click OK.
68+
5. The folder should be added to the bottom of the "Path" list.
7369
Make sure that the new entry (which should be highlighted) is at the bottom of the list; if not, click on "Move Down" until it is.
74-
9. Click "OK" to finish the "Edit environment variable" dialog, and again for the "Environment Variables" dialog.
70+
6. Click "OK" to finish the "Edit environment variable" dialog, and again for the "Environment Variables" dialog.
7571

7672
</TabItem>
7773
<TabItem value="cmd" label="Command Prompt">

0 commit comments

Comments
 (0)