Fix up docs

diff --git a/README.md b/README.md
index 95396361c41802065651d22304318dc9a7d1fd3d..6b9e44bee953327fe58ea9b47363bcab859cdc7c 100644 (file)
--- a/README.md
+++ b/README.md
@@ -39,7 +39,7 @@ If you just want to play on a server hosted by someone else, you need to follow
 
 ### Server
 
-See the [docs](https://github.com/AeonLucid/Impostor/docs/Running-the-server) for instructions on how to set it up.
+See the [docs](docs/Running-the-server) for instructions on how to set it up.
 
 ## Contributing
 

diff --git a/docs/Building-from-source.md b/docs/Building-from-source.md
index 2e1af2fca17960ee21e9e78e6d38b94d09e23bd4..87d93ecc56ca433c0f41cf68cbc62b0fe7ad7d6a 100644 (file)
--- a/docs/Building-from-source.md
+++ b/docs/Building-from-source.md
@@ -1,32 +1,45 @@
-The solution file contains two main projects which are the Impostor Client and the Impostor Server and are built using different .net versions being .NET Framework (netfx) 4.52 for the client and .net 5 for the server.
-For now, .net 5 is still not officially released (it's in release candidate) so in order to build using Visual Studio, you should have Visual Studio Preview installed.
+# 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.
 
-### Cloning the repo
-Since Impostor uses git submodule to reference [Hazel](https://github.com/AeonLucid/Impostor/tree/master/submodules) you should include the ```--recurse-submodules``` option to ```git clone``` command. ie:
+## Cloning Impostor
+
+You need to clone Impostor with all submodules.
+
 ```bash
-git clone --recurse-submodules https://github.com/AeonLucid/Impostor.git
+git clone --recursive https://github.com/AeonLucid/Impostor.git
+```
+
+If you already have cloned Impostor but have errors related to Hazel, run the following.
+
+```bash
+git submodule update --init
 ```
-if you're using https.
 
 ## 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)
+- [.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)
 
 ### Build using the CLI
+
 ```bash
-cd Impostor/src/Impostor.Server/
+cd src/Impostor.Server/
 dotnet build
 ```
-To setup the configs and run it, please look at [Running the server](Running-the-server)
+To setup the server, please look at [Running the server](Running-the-server).
 
 ## Building the client
+
 ### Dependencies
-* [.NET Framework 4.5.2 Developer Pack](https://dotnet.microsoft.com/download/dotnet-framework/thank-you/net452-developer-pack-offline-installer) (aka SDK)
+* [.NET Framework 4.7.2 Developer Pack](https://dotnet.microsoft.com/download/dotnet-framework/thank-you/net472-developer-pack-offline-installer)
 
 ### Build using the CLI
 ```bash
-cd Impostor/src/Impostor.Client/
+cd src/Impostor.Client/Impostor.Client.WinForms
 dotnet build
 ```
\ No newline at end of file

diff --git a/docs/FAQ.md b/docs/FAQ.md
index 7bb2f75777ef7e54aebb34e6921c66a9c57f8e29..b0c14af26631339c3e30d3c6908db26e959610e6 100644 (file)
--- a/docs/FAQ.md
+++ b/docs/FAQ.md
@@ -1,9 +1,11 @@
-### What is this?
-> The Impostor project is a reverse engineered and open sourced server for the game Among Us. The game itself is developed by [InnerSloth](http://www.innersloth.com/) while this project is maintained by the community. This project was built out of frustration for the lack of server availability in certain regions and the inability for the core developer, [AeonLucid](https://github.com/AeonLucid), to join a public game. As of this time, it has not been officially endorsed by the studio.  
+# Frequently Answered Questions
 
-### Can this be used with the mobile version of the game?
-> Yes, Impostor can be used with both the Android and iOS\* versions of the game. 
+## What is this?
+The Impostor project is a reverse engineered and open sourced server for the game Among Us. The game itself is developed by [InnerSloth](http://www.innersloth.com/) while this project is maintained by the community. This project was built out of frustration for the lack of server availability in certain regions and the inability for the core developer, [AeonLucid](https://github.com/AeonLucid), to join a public game. As of this time, it has not been officially endorsed by the studio.  
+
+## Can this be used with the mobile version of the game?
+Yes, Impostor can be used with both the Android and iOS\* versions of the game. 
 ###### \* In order to play on an Impostor server with iOS, you _must_ have a jailbroken device.
 
-### How can I get started?
-> See [Setting up your Server](Running-the-server) for more information on running the server and [Client Setup](https://aeonlucid.com/Impostor/) for helping your friends join in!
\ No newline at end of file
+## How can I get started?
+See [Setting up your Server](Running-the-server) for more information on running the server and [Client Setup](https://aeonlucid.com/Impostor/) for helping your friends join in!
\ No newline at end of file

diff --git a/docs/Running-the-server.md b/docs/Running-the-server.md
index 5609e6c06de07b1431ae40c467c2e5c45a858563..3924f6c09ebae0d561142179fe6896b649a96593 100644 (file)
--- a/docs/Running-the-server.md
+++ b/docs/Running-the-server.md
@@ -1,3 +1,5 @@
+# Running the server
+
 There are currently two modes to run the Impostor server in. The first way is the simplest one and is the one you should probably use. The other way will distribute players across other servers and is a more advanced configuration.
 
 ## Single server