diff --git a/README.md b/README.md index af8542c4..657264cb 100644 --- a/README.md +++ b/README.md @@ -24,6 +24,22 @@ Features * System Information * Computer Commands (Restart, Shutdown, Standby) +Compiling +--- +Open the project in Visual Studio and click build, or use one of the batch files included in the root directory. + +| Batch file | Description +| ----------------- |:------------- +| build-debug.bat | Builds the application using the debug configuration (for testing) +| build-release.bat | Builds the application using the release configuration (for publishing) + +Building a client +--- +| Build configuration | Description +| ----------------------------|:------------- +| debug configuration | The pre-defined [Settings.cs](/Client/Config/Settings.cs) will be used. The client builder does not work in this configuration. You can execute the client directly with the specified settings. +| release configuration | Use the client builder to build your client otherwise it is going to crash. + ToDo --- * ~~Startup Manager~~