From 2e199c708b49da36e7005ec2ff88fdc70d76a437 Mon Sep 17 00:00:00 2001 From: elricsfate <35166410+elricsfate@users.noreply.github.com> Date: Sat, 9 Nov 2024 17:01:09 +0100 Subject: [PATCH] Clarify locations for getting started in README (#87739) ## About The Pull Request This is a `README.md` update to more efficiently point potential contributors to the appropriate documentation for configuring their dev environment. ## Why It's Good For The Game It is typically best practice to make it easy for developers to quickly contribute a change to a project by making things as clear as possible. --- README.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 6fccae54e43..a28f9100371 100644 --- a/README.md +++ b/README.md @@ -39,12 +39,15 @@ Space Station 13 is a paranoia-laden round-based roleplaying game set against th **[How to compile in VSCode and other build options](tools/build/README.md).** -## Contributors -[Guides for Contributors](.github/CONTRIBUTING.md) +## Getting started -[/tg/station HACKMD account](https://hackmd.io/@tgstation) - Design documentation here +For contribution guidelines refer to the [Guides for Contributors](.github/CONTRIBUTING.md). -[Interested in some starting lore?](https://github.com/tgstation/common_core) +For getting started (dev env, compilation) see the HackMD document [here](https://hackmd.io/@tgstation/HJ8OdjNBc#tgstation-Development-Guide). + +For overall design documentation see [HackMD](https://hackmd.io/@tgstation). + +For lore, [see Common Core](https://github.com/tgstation/common_core). ## LICENSE