Skip to content

Commit

Permalink
Clarify locations for getting started in README (tgstation#87739)
Browse files Browse the repository at this point in the history
## 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.
  • Loading branch information
elricsfate authored Nov 9, 2024
1 parent c6b8930 commit 2e199c7
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit 2e199c7

Please sign in to comment.