gbdev / rgbds-www

RGBDS website, hosting documentation and install instructions. Built with Docusaurus, content from RGBDS man pages.
https://rgbds.gbdev.io
Other
7 stars 7 forks source link

Overhaul "Install" instructions #48

Closed avivace closed 1 year ago

avivace commented 1 year ago

I wasn't quick enough to review #47, so let me try again.

The install page suffers from a lot of problems right now, making the whole thing unreadable and inaccessible to the average target of "new users of RGBDS".

Let's try to review the criteria:

Feel free to discuss any of these points. In the meantime, I started an overhaul:

Fixes #51.

ISSOtm commented 1 year ago

Are you sure the largest portion of our user base is on Linux? Lacking any better info (people will get mad if we add any telemetry), I've been referencing the Sublime Text extension's stats, which are approximately 50% Windows, 25% macOS, 25% Linux. [EDIT] Since Sublime is non-free software, and not in any distro's default repos, maybe the Linux share is biased downwards. IDRK.

As far as I'm aware, distributing raw Linux binaries is a bad idea because they'll be incompatible across distributions? I will look up info on that.

avivace commented 1 year ago

Let's also remember to mention rgbenv

avivace commented 1 year ago

This is currently blocked by https://github.com/gbdev/rgbds/pull/1148 not being applied to old releases, so we don't have the Linux build until we release

avivace commented 1 year ago

https://github.com/gbdev/rgbds-www/issues/51 could also be fixed here

ISSOtm commented 1 year ago

I'm not sure Docker would be much use for installing RGBDS?

pinobatch commented 1 year ago

It has been suggested to use https://nightly.link/ to solve the lack of guest downloads for master.

avivace commented 1 year ago

@ISSOtm

I'm not sure Docker would be much use for installing RGBDS?

The container image provides a very quick way, literally a oneliner (if you have a container runtime installer ofc) to obtain a linux environment able to run AND build RGBDS (the version you're checking out, but potentially any other).

It may also be useful as a "base" image for pipelines.

Anyway, we'll have some stats in a while on how popular/really used really is, so I'm okay in removing it from the options if it we understand is not really used..


Another thing, are we really sure we want the Tabs navigation here? Now the instructions were slimmed down, they seem to amount just 4-5 lines per platform so I'm now sure if requiring additional clicks is really useful?


@PinoBatch where should the nightly link https://nightly.link/gbdev/rgbds/workflows/testing/master go? In the "Install master?" (https://rgbds.gbdev.io/install/master) (which could also be renamed to "Canary" tbf, it's clearer