From 32bbcf546ee0b0480781ecfcf394aadac9c7cc1b Mon Sep 17 00:00:00 2001 From: Jordan Brown Date: Sat, 28 Mar 2020 12:58:55 -0400 Subject: [PATCH] Update repo docs --- .github/CONTRIBUTING.md | 12 +++++++++--- README.md | 2 +- 2 files changed, 10 insertions(+), 4 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 8d81ccf5c3..98c672779c 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -34,11 +34,17 @@ You can of course, as always, ask for help at [#coderbus](irc://irc.rizon.net/co ### Development Environment -You need the Dotnet 2.1 SDK and npm>=v5.7 (in your PATH) to compile the server. In order to build the service version you also need a .NET 4.7.1 build chain +You need the Dotnet 2.2 SDK and npm>=v5.7 (in your PATH) to compile the server. In order to build the service version you also need a .NET 4.7.1 build chain -The recommended IDE is Visual Studio 2017 which has installation options for both of these. +The recommended IDE is Visual Studio 2019 which has installation options for both of these. -In order to run the integration tests you must have the environment variables `TGS4_TEST_DATABASE_TYPE` set to `MySql`, `MariaDB` or `SqlServer` and `TGS4_TEST_CONNECTION_STRING` set appropriately +In order to run the integration tests you must have the following environment variables set: +- `TGS4_TEST_DATABASE_TYPE`: `MySql`, `MariaDB` or `SqlServer`. +- `TGS4_TEST_CONNECTION_STRING`: To a valid database connection string. You can use the setup wizard to create one. + +The following environment variables aren't required but enable more tests. +- `TSG4_TEST_DISCORD_TOKEN`: To a valid discord bot token. +- `TGS4_TEST_DISCORD_CHANNEL`: To a valid discord channel ID that the above bot can access. ## Specifications diff --git a/README.md b/README.md index 00159826b7..4e7ea783b8 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ Older server versions can be found in the V# branches of this repository. Note t ### Pre-Requisites -- [.NET Core Runtime (>= v2.1)](https://www.microsoft.com/net/download) If you plan to install tgstation-server as a Windows service, you should also ensure that your .NET Framework runtime version is >= v4.7.1 (Download can be found on same page). On Windows, ensure that the `dotnet` executable file is in your system's `PATH` variable (or the user's that will be running the server). +- [.NET Core Runtime (>= v2.2)](https://www.microsoft.com/net/download) If you plan to install tgstation-server as a Windows service, you should also ensure that your .NET Framework runtime version is >= v4.7.1 (Download can be found on same page). On Windows, ensure that the `dotnet` executable file is in your system's `PATH` variable (or the user's that will be running the server). - A [MariaDB](https://downloads.mariadb.org/), MySQL, or [Microsoft SQL Server](https://www.microsoft.com/en-us/download/details.aspx?id=55994) database engine is required ### Installation