From fa23ec8fc63091c82256addfa80c1b9a4abe4e89 Mon Sep 17 00:00:00 2001 From: Swept Date: Fri, 23 Apr 2021 19:23:54 +0000 Subject: [PATCH] Updates the README.md --- README.md | 25 ++++++++----------------- 1 file changed, 8 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index f47e0ce94..4363747e9 100644 --- a/README.md +++ b/README.md @@ -1,25 +1,16 @@ ![Robust Toolbox](https://raw.githubusercontent.com/space-wizards/asset-dump/3dd3078e49e3a7e06709a6e0fc6e3223d8d44ca2/robust.png) -[![Build status](https://ci.appveyor.com/api/projects/status/ygb7t8hsj3wt7pnm/branch/master?svg=true)](https://ci.appveyor.com/project/Silvertorch5/space-station-14/branch/master) -[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=ss14&metric=coverage)](https://sonarcloud.io/dashboard?id=ss14) +Robust Toolbox is an engine primarily being developed for [Space Station 14](https://github.com/space-wizards/space-station-14), although we're working on making it usable for both [singleplayer](https://github.com/space-wizards/RobustToolboxTemplateSingleplayer) and [multiplayer](https://github.com/space-wizards/RobustToolboxTemplate) projects. -Robust Toolbox is a client/server backend for [Space Station 14](https://github.com/space-wizards/space-station-14). +Use the [content repo](https://github.com/space-wizards/space-station-14) for actual development, even if you're modifying the engine itself. -### *This repository is the *engine* section of SS14. This is the base engine all SS14 servers will be built on. As such, it does not start on its own: it needs the [content repo](https://github.com/space-wizards/space-station-14). Use said repo for actual development, even if you're modifying the engine itself. Think of Robust Toolbox as BYOND in the context of Spacestation 13.* +## Project Links -## Getting in Touch +[Website](https://spacestation14.io/) | [Discord](https://discord.gg/t2jac3p) | [Forum](https://forum.spacestation14.io/) | [Steam](https://store.steampowered.com/app/1255460/Space_Station_14/) | [Standalone Download](https://spacestation14.io/about/nightlies/) -* Website: [spacestation14.io](https://spacestation14.io/) -* Discord: [Invite Link](https://discord.gg/t2jac3p) -* IRC: `irc.rizon.net#spacebus` -* Code Analysis: [Sonar Cloud](https://sonarcloud.io/dashboard?id=ss14) -* Automatic Content Builds: [builds.spacestation14.io](https://builds.spacestation14.io/jenkins/) +## Documentation/Wiki -The IRC is setup to relay back and forth to the Discord server so [IRC nerds](https://xkcd.com/1782/) will not be left out. - -## Documentation - -We have various technical documentation articles on the [HackMD Wiki](https://hackmd.io/@ss14/docs/%2F%40ss14%2Ftechnical-documentation-overview). +The [HackMD Wiki](https://hackmd.io/@ss14/docs/wiki) has documentation on SS14s content, engine, game design and more. We also have lots of resources for new contributors to the project. ## Contributing @@ -27,8 +18,8 @@ We are happy to accept contributions from anybody. Get in Discord or IRC if you ## Building -**In practice, you usually don't build this repository directly.** +This repository is the **engine** part of SS14. It's the base engine all SS14 servers will be built on. As such, it does not start on its own: it needs the [content repo](https://github.com/space-wizards/space-station-14). Think of Robust Toolbox as BYOND in the context of Spacestation 13. ## Legal Info -See `legal.md` for licenses and copyright. +See [legal.md](https://github.com/space-wizards/RobustToolbox/blob/master/legal.md) for licenses and copyright.