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.

Sign up for GitHub

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

Overhaul "Install" instructions #48

Merged
merged 5 commits into from
Oct 11, 2023
Merged

Overhaul "Install" instructions #48

Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
16e1bfa
Remove windows "tip"
avivace Jul 2, 2023
5ea3211
Remove mention of rgbds2
avivace Jul 2, 2023
1a98d37
simplify instructions
avivace Sep 25, 2023
7f9500f
Restructure and improve Windows install instructions
ISSOtm Sep 28, 2023
35e2a0d
final formatting fixes
avivace Oct 11, 2023
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
69 changes: 42 additions & 27 deletions src/pages/install/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,25 +4,46 @@ import TabItem from '@theme/TabItem';

# Installing RGBDS

Most people will want to use a release (the latest the bestest!), but if you are willing to help us test new features, you may consider [using a development version](/install/master).
Most people will want to use a stable release (the more recent the better).

The two main options to install a release of RGBDS are to download pre-built executables, or to [build from source](/install/source).
Below is a list of <abbr title="Operating System">OS</abbr>es for which we know pre-built executables are available.
Below is a list of Operative Systems for which pre-built executables are available. If none of these options fits your needs, you can [build from source](/install/source).

Comment on lines +9 to 10
Copy link
Member

@ISSOtm ISSOtm Sep 28, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Below is a list of Operative Systems for which pre-built executables are available. If none of these options fits your needs, you can [build from source](/install/source).
Below is a list of OSes for which pre-built executables are available.
If none of these options fits your needs, you can [build from source](/install/source).

We can use <abbr title="Operating Systems"> to explain "OSes" instead, if desired.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agree!

If your OS isn’t listed below, try finding `rgbds` in your package manager—refer to your OS' documentation for help.
If you still can’t find RGBDS, or the specific version you are looking for is unavailable, you will have to [compile it from source](#building-from-source).

<Tabs>
<TabItem value="windows" label="Windows">
<TabItem value="linux" label="Linux">

The install instructions change a bit depending on the environment you wish to use RGBDS with.
Linux x86_64 ready binaries are available in our [Releases](https://github.com/gbdev/rgbds/releases) page.

##### Arch
Copy link
Member

@ISSOtm ISSOtm Sep 28, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
##### Arch
### Arch

We're only at heading level 2 here; but level 3 seems appropriate too.


RGBDS is available in the official Arch Linux repositories as [`community/rgbds`](https://www.archlinux.org/packages/community/x86_64/rgbds/); you can also get the [latest master](/docs/master) via the [`rgbds-git`](https://aur.archlinux.org/packages/rgbds-git) AUR package.

```bash
pacman -S rgbds
```

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change


</TabItem>

:::tip
<TabItem value="macos" label="macOS">

RGBDS is available on [Homebrew](https://brew.sh) as the [`rgbds` package](https://formulae.brew.sh/formula/rgbds).

The "plain Windows" instructions may also work for some environments listed further below, since most of them pick up Windows' `PATH`.
However, if you have such an environment, we recommend you follow its specific install instructions instead.
```bash
brew install rgbds
```

:::
You can also install the [`master` branch](/docs/master) by passing the `--HEAD` flag:

```bash
brew install rgbds --HEAD
```

</TabItem>

<TabItem value="windows" label="Windows">

The install instructions change a bit depending on the environment you wish to use RGBDS with.

<details>
<summary>"Plain" Windows (CMD, PowerShell)</summary>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually, the WSL instructions should instruct to refer to the Linux instructions for the corresponding Linux distribution (noting that if you don't know, it's probably Ubuntu).

I'm thinking we should organise the tabs something like WSL, then MSYS2 or Cygwin, and finally none of these. That should make what the last one is about, clearer. I think.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This seems a good idea, although I have no experience whatsoever on Windows so if you have any specific ideas on how to reorganize the Windows tab feel free to push

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not a Windows user anymore, but I think I have some ideas. I'll do that then.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK, done!

Expand Down Expand Up @@ -78,30 +99,24 @@ On WSL, the default package manager (to install any build prerequisites) is `apt
</details>

</TabItem>
<TabItem value="arch" label="Arch Linux">

RGBDS is now available in the official repos as [`community/rgbds`](https://www.archlinux.org/packages/community/x86_64/rgbds/); you can also get the [latest master](/docs/master) via the [`rgbds-git`](https://aur.archlinux.org/packages/rgbds-git) AUR package, or RGBDS 0.2.5 from [`rgbds2`](https://aur.archlinux.org/packages/rgbds2), still from the AUR.
<TabItem value="docker" label="Docker">

We distribute an [official container image for RGBDS](https://github.com/gbdev/rgbds/pkgs/container/rgbds). It contains the built executables and the build dependencies in case you want to compile from source.

```bash
pacman -S rgbds
docker pull ghcr.io/gbdev/rgbds:latest
```

We refer you to the Arch Linux wiki on how to install [official packages](https://wiki.archlinux.org/index.php/Pacman#Installing_packages) or [AUR packages](https://wiki.archlinux.org/index.php/Arch_User_Repository#Installing_and_upgrading_packages), or to find and use an [AUR helper](https://wiki.archlinux.org/index.php/AUR_helpers).

</TabItem>
<TabItem value="macos" label="macOS">
</Tabs>

RGBDS is available on [Homebrew](https://brew.sh) as the [`rgbds` package](https://formulae.brew.sh/formula/rgbds).
<br />

```bash
brew install rgbds
```
### Installing a development version

You can also install the [`master` branch](/docs/master) by passing the `--HEAD` flag:
If you are willing to help us test new features, consider [using a development version](/install/master).

```bash
brew install rgbds --HEAD
```
### Managing multiple versions

</TabItem>
</Tabs>
If you need to frequently switch between different versions of RGBDS, consider using [rgbenv](https://github.com/gbdev/rgbenv), the RGBDS version manager.