Adds getting started to docs (#249)

- [X] Adds getting started to docs

Updates documentation
This commit is contained in:
Kamron Batman 2020-09-14 00:40:19 -07:00 committed by GitHub
parent 8149620b0c
commit b4cad61e36
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
6 changed files with 102 additions and 10 deletions

29
docs/building-server.md Normal file
View file

@ -0,0 +1,29 @@
# Building the Server
## Compiling
=== "Windows"
```bash
./publish.cmd <os> <framework> <release|debug>
```
=== "OSX/Linux"
```bash
./publish.sh <os> <framework> <release|debug>
```
<br><br>
`os` (_Optional_)<br>
The operating system to build the server against. If not specified then the server will be built for the same operating system.
:fontawesome-brands-windows:{: .windows } `win`<br>
:fontawesome-brands-apple:{: .apple } `osx`<br>
:fontawesome-brands-ubuntu:{: .ubuntu } `ubuntu.16.04`, `ubuntu.18.04` `ubuntu.20.04`<br>
:brands-debian:{: .debian } `debian.9`, `debian.10`<br>
:fontawesome-brands-centos:{: .centos } `centos.7`, `centos.8`<br>
<br>
`framework` (_Optional_)<br>
The framework used to build the server. That framework must be installed.
.NET Core 3.1 `core`<br>
.NET 5 Preview `net`