1c34b7b73e
* Contribution reorganization: Theft Edition (#61451) A while back oranges made this really nice pr. #59465 It was mostly done to make snake_case mandatory for pretty much everything, along with a few other style things. But he got fed up with our 800 line contrib file, and decided to split it up. I share a similar hatred for our guidelines, people don't read them and finding anything is just guesswork People will just throw their work at the bottom or top of a file with no regard for any order. It's hell to read and work with. So I "borrowed legally under agpl v3" ~~stole~~ his code and expanded on it. I think? he was working with the intent of splitting the main tower file into several different subfiles. I don't think I have the right vision to do that properly, but I've done what I can. Splits contributing.md's Specifications section into 2 files: - Style.md, which describes formatting patterns and clean code. - Standards.md, this lays out the rules we have for code. More function, less cleanliness. Each file is separated into different sections. They cover things like styling for procs, variables, paths, or how to structure your code properly, optimization pitfalls to avoid, etc. I've also created a development guides section in the contributing guidelines, to include links the above alongside things like autodoc, hard deletes, and the policy config section. Makes a subfolder of .github called /guides to hold files like this, and the ones that exist to teach people how to set up servers. ## Why It's Good For The Game I got bored, and MSO took away my keys, so I can't fix harddels right now. Plus if I did my job right this will make learning from and adding to what we've written down much easier. * Contribution reorganization: Theft Edition Co-authored-by: LemonInTheDark <58055496+LemonInTheDark@users.noreply.github.com>
1.0 KiB
DOWNLOADING
There are a number of ways to download the source code. Some are described here, an alternative all-inclusive guide is also located at https://www.tgstation13.org/wiki/Downloading_the_source_code
Option 1: Follow this: https://www.tgstation13.org/wiki/Setting_up_git
Option 2: Download the source code as a zip by clicking the ZIP button in the code tab of https://github.com/tgstation/tgstation (note: this will use a lot of bandwidth if you wish to update and is a lot of hassle if you want to make any changes at all, so it's not recommended.)
Option 3: Download a pre-compiled nightly at https://tgstation13.download/nightlies/ (same caveats as option 2)
Warning: option 4 is out of date, and not maintained, use at your own risk
Option 4: Use our docker image that tracks the master branch (See commits for build status. Again, same caveats as option 2)
docker run -d -p <your port>:1337 -v /path/to/your/config:/tgstation/config -v /path/to/your/data:/tgstation/data tgstation/tgstation <dream daemon options i.e. -public or -params>