From c71ea23bf5ffce467bb263cee4b2eca6034c22cb Mon Sep 17 00:00:00 2001
From: Skyler Clark <wgahnagl@protonmail.com>
Date: Fri, 16 Oct 2020 11:32:54 -0400
Subject: [PATCH] adds OpenSim.ini to the gitignore and updates build
 instructions

Signed-off-by: Skyler Clark <wgahnagl@protonmail.com>
Signed-off-by: UbitUmarov <ajlduarte@sapo.pt>
---
 .gitignore  |  1 +
 BUILDING.md | 75 +++++++++++++++++++++++++++++++++++++----------------
 2 files changed, 53 insertions(+), 23 deletions(-)

diff --git a/.gitignore b/.gitignore
index 1b43a58bd4..b1d9339ae2 100644
--- a/.gitignore
+++ b/.gitignore
@@ -113,5 +113,6 @@ OpenSim/Tests/test-results/
 test-results/
 doc/html
 doc/doxygen.error.log
+bin/config-include/OpenSim.ini
 
 *.patch
diff --git a/BUILDING.md b/BUILDING.md
index 99e4ab854b..34263ea5bc 100644
--- a/BUILDING.md
+++ b/BUILDING.md
@@ -1,37 +1,66 @@
 # Building on Windows
 
-Steps:
+## Requirements
+  For building under Windows, the following is required:
 
- * runprebuild.bat
- * Load OpenSim.sln into Visual Studio .NET and build the solution.
- * chdir bin 
- * copy OpenSim.ini.example to OpenSim.ini and other appropriate files in bin/config-include
- * run OpenSim.exe
+  * [Visual Studio .NET](https://visualstudio.microsoft.com/vs/features/net-development/), version 2015 or later
+
+### Building Standalone
+ To create the project files, run   
+
+ ```runprebuild.bat```
+
+Load the generated OpenSim.sln into Visual Studio .NET and build the solution.
+
+Copy `OpenSim.ini.exmple` to `OpenSim.ini` in the `bin/config-include` directory, and verify that the `[Const]` and `[Architecture]` sections are what you want.
+
+copy the `StandaloneCommon.ini.example` to `StandaloneCommon.ini` in the `bin/config-include` directory.
+
+The StandaloneCommon.ini file describes the database and backend services that OpenSim will use, and is set to use sqlite by default, which requires no setup.
+
+Now just run `OpenSim.exe` from the `bin` folder, and set up the region.
 
 # Building on Linux / Mac
 
-Prereqs:
+## Requirements
 
- *	Mono > 5.0
+ *	[Mono > 5.0](https://www.mono-project.com/download/stable/#download-lin)
  *	On some Linux distributions you may need to install additional packages.
- *	msbuild or xbuild if still supported by the mono version
- *   See http://opensimulator.org/wiki/Dependencies for more information.
+ *	msbuild or xbuild(deprecated) if still supported by the mono version
+ *   See [the wiki](http://opensimulator.org/wiki/Dependencies) for more information.
 
-From the distribution type:
+### Building Standalone
+  To create the project files, run:
+
+  ```./runprebuild.sh```
+
+  then run ```msbuild``` or ```xbuild``` if xbuild was installed.
+
+ Copy `OpenSim.ini.exmple` to `OpenSim.ini` in the `bin/config-include` directory, and verify that the `[Const]` and `[Architecture]` sections are what you want.
+
+copy the `StandaloneCommon.ini.example` to `StandaloneCommon.ini` in the `bin/config-include` directory.
+
+ The StandaloneCommon.ini file describes the database and backend services that OpenSim will use, and is set to use sqlite by default, which requires no setup.
+
+run `./opensim.sh` from the `bin` folder, and set up the region
+
+For rebuilding and debugging use the msbuild option switches
+  *  clean:  `msbuild /target:clean`
+  *  debug: (default) `msbuild /property:Configuration=Debug`
+  *  release: `msbuild /property:Configuration=Release`
+
+
+# Building other versions
+Other versions of OpenSim can be built by changing the .ini files in bin/config-include
+
+For example, if you wanted to create an instance of OpenSim running in grid mode, comment the version that you currently have, (by default it is Standalone.ini) and uncomment
+```Include-Architecture = "config-include/Grid.ini"```
+and copy the `GridCommon.ini.example` file to `GridCommon.ini` inside the `bin/config-include` directory.
+
+The same can be done for `StandaloneHypergrid.ini`, and `GridHyperGrid.ini`.
 
- * ./runprebuild.sh
- * type msbuild or xbuild
- * cd bin 
- * copy OpenSim.ini.example to OpenSim.ini and other appropriate files in bin/config-include
- * review and change those ini files according to your needs
- * windows: execute opensim.exe or opensim32.exe for small regions
- * linux: run ./opensim.sh
- * msbuild (xbuild) option switches
-   *  clean:  msbuild /target:clean
-   *  debug: (default) msbuild /property:Configuration=Debug
-   *  release: msbuild /property:Configuration=Release
 
 # References
- 
+
 Helpful resources:
 * http://opensimulator.org/wiki/Build_Instructions