OpenRCT2 / OpenRCT2/docs

Make installation pages more complete

Open
#43 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
12
Forks
15
PR merge metrics
No merged PRs in 30d

Description

Currently, most of the documentation is spread out around openrct2.org, openrct2.io, the GitHub wiki, Reddit posts and docs.openrct2.io. The goal is to concentrate all this documentation in one place (and link to it from the older sources). Also, much of the documentation is written in a quite generic way, while the docs can give more specific instructions for every operating system, hopefully increasing its user-friendliness.

  • Windows
    • Installing OpenRCT2
    • Retrieving files from RCT2
    • Retrieving files from RCT Classic + Mini Game
    • Retrieving files from RCT1
  • macOS
    • Installing OpenRCT2
    • Retrieving files from RCT2: disc
    • Retrieving files from RCT2: GOG
    • Retrieving files from RCT2: Steam
    • Retrieving files from RCT Classic + Mini Game
    • Retrieving files from RCT1: disc
    • Retrieving files from RCT1: GOG
    • Retrieving files from RCT1: Steam
  • Linux
    • Installing OpenRCT2
      • Distro-specific
      • AppImage
      • Compiling yourself
    • Retrieving files from RCT2: disc
    • Retrieving files from RCT2: GOG
    • Retrieving files from RCT2: Steam
    • Retrieving files from RCT Classic + Mini Game
    • Retrieving files from RCT1: disc
    • Retrieving files from RCT1: GOG
    • Retrieving files from RCT1: Steam

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the existing installation material across openrct2.org, openrct2.io, the GitHub wiki, Reddit posts, and docs.openrct2.io. Organize the relevant instructions in one location, cover the Windows, macOS, and Linux checklist items, and link older sources to the consolidated documentation.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.