From d4bffd20adfa7b5b4f69752d3bf46676f939500d Mon Sep 17 00:00:00 2001 From: js6pak Date: Wed, 3 Mar 2021 09:05:33 +0000 Subject: [PATCH] [skip ci] Update Building-from-source.md --- docs/Building-from-source.md | 25 ++++++++----------------- 1 file changed, 8 insertions(+), 17 deletions(-) diff --git a/docs/Building-from-source.md b/docs/Building-from-source.md index cf3632f..2254f16 100644 --- a/docs/Building-from-source.md +++ b/docs/Building-from-source.md @@ -1,29 +1,20 @@ # Building from source -The solution contains two main projects, the Impostor client and server. The client is built using [.NET Framework 4.7.2](https://dotnet.microsoft.com/download/dotnet-framework/net472) and the server with [.NET 5](https://dotnet.microsoft.com/download/dotnet/5.0). - -Currently .NET 5 is not yet officially released, so in order to build using Visual Studio, you should have Visual Studio 2019 **Preview** installed. -This documentation will go over building both the [Server](#building-the-server) and the [Client](#building-the-client) and their requirements. +The solution contains two main projects, the Impostor server and patcher. The server is built using [.NET 5](https://dotnet.microsoft.com/download/dotnet/5.0) and the winforms patcher is with [.NET Framework 4.7.2](https://dotnet.microsoft.com/download/dotnet-framework/net472). ## Cloning Impostor -You need to clone Impostor with all submodules. - -```bash -git clone --recursive https://github.com/AeonLucid/Impostor.git -``` - -If you already have cloned Impostor but have errors related to Hazel, run the following. +You need to clone Impostor using git. ```bash -git submodule update --init +git clone https://github.com/AeonLucid/Impostor.git ``` ## Building the server ### Dependencies - [.NET 5 SDK](https://dotnet.microsoft.com/download/dotnet/5.0) -- [Visual Studio Preview](https://visualstudio.microsoft.com/vs/preview/) (Optional, only if you want the full IDE experience) +- [Rider](https://www.jetbrains.com/rider/) or [Visual Studio](https://visualstudio.microsoft.com/vs/) (Optional, only if you want the full IDE experience) ### Build using the CLI @@ -33,13 +24,13 @@ dotnet build ``` To setup the server, please look at [Running the server](Running-the-server.md). -## Building the client +## Building the winforms patcher ### Dependencies -* [.NET Framework 4.7.2 Developer Pack](https://dotnet.microsoft.com/download/dotnet-framework/thank-you/net472-developer-pack-offline-installer) +* [.NET Framework 4.7.2 Developer Pack](https://dotnet.microsoft.com/download/dotnet-framework/thank-you/net472-developer-pack-offline-installer) or [Mono](https://www.mono-project.com/download/) ### Build using the CLI ```bash -cd src/Impostor.Client/Impostor.Client.WinForms +cd src/Impostor.Patcher/Impostor.Patcher.WinForms dotnet build -``` \ No newline at end of file +``` -- 2.39.5