Closed
Description
The current installation instructions are potentially confusing, more so for the users who need the help most (typically Windows ones).
We have a lot of ways to install RGBDS; in no particular order:
- Homebrew on macOS
- Pacman on Arch Linux
- Docker (if you have that installed)
- Building from source...
- ...using a downloaded .zip or Git clone
- ...getting prerequisites with your Linux/WSL package manager, macOS
brew
, or (most complicated) Cygwin - ...using
make
orcmake
- ...plus more variants for old
cmake
versions
- ...plus more variants for old
- ...and how to add it to
PATH
for Windows- ...with
cmd
or Powershell
- ...with
- Using
rgbenv
(which has its own build instructions) - Another page on how to use the
master
development branch...- ...building from source (semi-redundant)
- ...Pacman on Arch Linux
- ...the CI builds (are these even worth officially promoting? especially given that "We only recommend doing this on Windows", but IMO shouldn't recommend something for Windows users that takes them to a page like this)
I think we should prioritize using the releases published on GitHub (with a separate page for Windows users explaining how to add the new .exe files to their PATH
).
Secondly, mention the packaged options for macOS and Arch Linux.
Thirdly, a separate page on how to build from source. This would have sections on how to install the prerequisites (with apt
, pacman
, brew
, Cygwin, etc), get the source (download the .zip or git clone
), build (make
or cmake
), and install (make install
or adding to PATH
).
Metadata
Assignees
Labels
No labels
Activity