Documentation update (#192)

* Add build documentation to README and Code Style Guide

* Add checkout and running instructions to readme

Author: CorruptComputer

README.md

@@ -1,11 +1,47 @@
 # Stationhub
-![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/unitystation/stationhub/dotnetcore.yml?style=flat-square)
-![Codacy grade](https://img.shields.io/codacy/grade/b6c9615ab3ba47f091efb0ff28e24798?style=flat-square)
-![AUR version](https://img.shields.io/aur/version/stationhub?style=flat-square)
-![Flathub](https://img.shields.io/flathub/v/org.unitystation.StationHub)
-![Discord](https://img.shields.io/discord/273774715741667329?style=flat-square)
+[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/unitystation/stationhub/dotnetcore.yml?style=flat-square)](https://github.com/unitystation/stationhub/actions/workflows/dotnetcore.yml)
+[![Codacy grade](https://img.shields.io/codacy/grade/b6c9615ab3ba47f091efb0ff28e24798?style=flat-square)](https://app.codacy.com/gh/unitystation/stationhub)
+[![AUR version](https://img.shields.io/aur/version/stationhub?style=flat-square)](https://aur.archlinux.org/packages/stationhub)
+[![Flathub](https://img.shields.io/flathub/v/org.unitystation.StationHub?style=flat-square)](https://flathub.org/apps/details/org.unitystation.StationHub)
+[![Discord](https://img.shields.io/discord/273774715741667329?style=flat-square)](https://discord.com/invite/tFcTpBp)
 
 This is the official launcher for Unitystation, it handles account creation, downloading, updating, and server joining.
 
 ## Tech-stack
-It is cross-platform using .Net 6.0 as the runtime and Avalonia for the UI.
+It is cross-platform using .NET 6 as the runtime and [Avalonia MVVM](https://docs.avaloniaui.net/guides/basics/mvvm) for the UI.
+
+## Building
+You'll need [git](https://git-scm.com) and the [.NET 6 SDK](https://dotnet.microsoft.com/en-us/download/dotnet/6.0) installed.
+
+To check out the repo you can run the following in the directory you'd like to save the repo locally:
+```
+git clone https://github.com/unitystation/stationhub.git
+```
+
+Once checked out you should be able to run the following in the directory with the `UnitystationLauncher.sln` file:
+```
+dotnet build
+```
+
+Dependencies should be automatically restored by NuGet during the build process.
+
+To test the build you just ran, you can do the following:
+```
+dotnet run --project ./UnitystationLauncher/UnitystationLauncher.csproj
+```
+
+## Contributing
+Before opening your pull request please ensure there are no compile warnings for any new code that you've added.
+
+.NET format is also enforced by the build pipeline, so before pushing your code you can run the following to make sure your code is formatted in the standard way:
+```
+dotnet format
+```
+
+Unit Tests are a work in progress currently, however once they are included you'll be able to run them with:
+```
+dotnet test
+```
+
+You'll want to ensure that existing tests pass, and make changes and additional tests where needed for your change.
+Also make sure to check out the [Code Style Guide](https://github.com/unitystation/stationhub/blob/develop/docs/code-style-guide.md) for the project.

docs/code-style-guide.md

@@ -0,0 +1,53 @@
+# Code Style Guide
+## Class names for specific types
+### Services
+Services should be single instance classes that are used to access external resources such as web requests and files.
+
+In `StandardModule.cs` we are registering every class which matches the pattern `*Service` as a single instance:
+```csharp
+builder.RegisterAssemblyTypes(ThisAssembly)
+    .Where(t => t.Name.EndsWith("Service"))
+    .SingleInstance();
+```
+
+These class types should all be placed inside the `Services` directory of the project.
+
+### View Models
+View Models are multi-instance classes which are tied to a View. These should be named the same as the view that they correspond to.
+
+In `StandardModule.cs` we are registering every class which matches the pattern `*ViewModel`:
+```csharp
+builder.RegisterAssemblyTypes(ThisAssembly)
+    .Where(t => t.Name.EndsWith("ViewModel"));
+```
+
+These class types should all be placed inside the `ViewModels` directory of the project.
+
+## Prefer using explicit types and new()
+Yes:
+```csharp
+Foo bar = new();
+```
+
+No:
+```csharp
+Foo bar = new Foo();
+var bar = new Foo();
+```
+
+## Prefer adding braces to statements
+This one will fail the code quality check in Codacy if not followed.
+
+Yes:
+```csharp
+if (something)
+{
+  return true;
+}
+```
+
+No:
+```csharp
+if (something)
+  return true;
+```

docs/flatpak-maintenance.md

@@ -18,7 +18,7 @@ The main thing to note is that the build servers disable internet access during
 ### No NuGet Updates
 If there are no NuGet updates then the update process should be quite simple.
 
-In the Flathub package repo there is a line at the top of `org.unitystation.StationHub.yaml` that defines the commit hash that the build server will check out before it builds.
+In the Flathub package repo there is a line in `org.unitystation.StationHub.yaml` that defines the commit hash that the build server will check out before it builds.
 It should look something like this:
 ```yaml
   - name: StationHub