diff --git a/Development.md b/Development.md new file mode 100644 index 0000000..3eae64b --- /dev/null +++ b/Development.md @@ -0,0 +1,19 @@ +# **Development** + +When working on the patcher, it is recommended you use an IDE. + +This is a Mono project, and was created using the MonoDevelop IDE. It should however be compatible with Visual Studio and VSCode (with the right extensions) as well. + +Here are instructions for setting up your development environment. + +## **Setting up the environment** + +**1.** Clone this repository to your local computer. At the time of writing, I have not yet configured external SSH access for this git instance, so you have to clone over HTTPS. The cloned directory will be referred to as `DevDir` from now on. + +**2.** Create a "target reference" directory to work against, this can be located anywhere and is just a regular folder. This will be referred to as `ReferenceDir` from now on. After creating it, copy all the content of `C:\Program Files\SafeExamBrowser\Application` to `ReferenceDir`. + +**3.** Download MonoMod. The project uses the [net452 release](https://github.com/MonoMod/MonoMod/releases/download/v22.07.31.01/MonoMod-22.07.31.01-net452.zip), I'm not sure if a different version will work. Extract the contents of the ZIP file and put it into your `ReferenceDir`. + +**4.** Open the `Directory.Build.props` file located in your `DevDir` and change the path to your `ReferenceDir`. Can be relative or absolute. + +**5.** Open your `DevDir` in your IDE and you're done! You have now set up your development environment. \ No newline at end of file