Updates documentation about building the software

README.md

@@ -1,8 +1,8 @@
 # EGIL SCIM client
 
-The EGIL SCIM client implements the EGIL profile of the SS 12000 
+The EGIL SCIM client implements the EGIL profile of the SS 12000:2018
 standard. It reads information about students, groups etc. from 
-LDAP and sends updates to a SCIM server.
+various data sources (LDAP, SQL or CSV) and sends updates to a SCIM server.
 
 EGIL SCIM client is developed and managed by Föreningen Sambruk, https://sambruk.se/portfolio/egil-dnp/.
 Contact Sambruk when you want to participate in the managed group for EGIL and get access to documentation and other features.
@@ -13,7 +13,7 @@ To find the latest released version, go to
 Documentation can be found in the 
 [doc directory](https://github.com/Sambruk/EgilSCIM/tree/master/doc), especially:
 
- * [Installing](doc/INSTALL.md)
+ * [Building](doc/BUILDING.md)
  * [Using](doc/USAGE.md)
 
 After downloading EGIL SCIM client, you can find example configuration

doc/BUILDING.md

@@ -0,0 +1,48 @@
+# Building EgilSCIM from source code
+
+EgilSCIM currently depends on the following libraries:
+
+* `libcurl` to send the SCIM request.
+* `boost` (general purpose C++ libraries)
+* `libldap` from OpenLDAP for fetching identity information using LDAP.
+
+`libldap` is only used on Unix based platforms.
+
+The build tool CMake is used to build the program.
+
+The easiest way to get the required dependencies and make sure CMake knows
+where they are, is to use the dependency manager vcpkg.
+
+## Building with CMake and vcpkg on a Unix based system
+
+Make sure the following is installed:
+
+* C++ compiler and tool chain
+* CMake
+* vcpkg (you may need to set the VCPKG_ROOT environment variable so CMake finds it)
+* libldap with header files (this dependency isn't managed by vcpkg)
+
+Then you can execute the following commands to build the program:
+
+`cmake --preset=unix`
+`cmake --build build`
+
+This should produce an EgilSCIMClient binary in the `build` directory.
+
+## Building with CMake and vcpkg on a Windows based system
+
+Make sure the following is installed:
+
+* Microsoft Visual Studio (other compilers are likely to work as well)
+* CMake
+* vcpkg (you may need to set the VCPKG_ROOT environment variable so CMake finds it)
+
+If you wish to use a different C++ toolchain you will need to modify the presets
+in `CMakePresets.json`.
+
+Then you can execute the following commands to build the program:
+
+`cmake --preset=windows`
+`cmake --build build --config Release`
+
+This should produce an EgilSCIMClient.exe binary in the `build\Release` directory.