From bd8c8812c98abe6a3e02b1989ae05b5aaecc915e Mon Sep 17 00:00:00 2001
From: Sett17 <raik.rohde@gmail.com>
Date: Sun, 6 Aug 2023 13:35:57 +0200
Subject: [PATCH] chore: update README.md

Update the documentation section to include the correct path to the docs file. Also, update the contributing section to use "We" instead of "I" to indicate a collective effort.
---
 README.md | 56 ++++++++++++++++++++++++++++++++++++++++++++++++-------
 1 file changed, 49 insertions(+), 7 deletions(-)

diff --git a/README.md b/README.md
index 19d83de..3c3899f 100644
--- a/README.md
+++ b/README.md
@@ -2,15 +2,57 @@
 
 SynthPointer.dll is a dynamic link library (DLL) for simulating pen input using the Synthetic Pointer API in Windows. It provides a set of functions that allow you to create a synthetic pointer device, manipulate its state, and inject pointer input.
 
-For detailed documentation of the functions and their usage, please refer to the [docs](docs.md) file.
+## Documentation
 
-## Building
-
-The project uses CMake for building and Clang as the compiler. The minimum required version of CMake is 3.10. The project is set up to export all symbols on Windows and to use the C99 standard.
+For detailed documentation of the functions and their usage, please refer to the [docs](./docs.md) file.
 
-## Download
+## Building
 
-The DLL is built with the GitHub Windows runner for each tag. You can download the latest version from the [releases](https://github.com/Sett17/SynthPointer.dll/releases) page on GitHub.
+To build the project, follow these steps:
+
+1. Ensure you have the required dependencies:
+    
+    - CMake (minimum version 3.10)
+    - Clang compiler
+    - Make
+
+2. Clone the repository:
+    
+    ```bash
+    git clone https://github.com/Sett17/SynthPointer.dll.git
+    ```
+    
+3. Navigate to the project directory and create a build directory:
+    
+    ```bash
+    cd SynthPointer.dll
+    mkdir build
+    ```
+    
+4. Configure the project using CMake:
+    
+    ```bash
+    cd build
+    cmake -G "Unix Makefiles" ..
+    ```
+    
+5. Build the project:
+    
+    ```bash
+    make
+    ```
+
+## Testing
+
+After building, you can run the tests using:
+
+```bash
+./tests.exe
+```
+
+## Releases
+
+The DLL is automatically built with GitHub Actions for each tag. You can download the latest version from the [releases](https://github.com/Sett17/SynthPointer.dll/releases) page on GitHub.
 
 ## License
 
@@ -18,4 +60,4 @@ The project is licensed under the [Unlicense](LICENSE).
 
 ## Contributing
 
-Contributions are welcome. Please open an issue or submit a pull request on GitHub. I am particularly interested in contributions that would extend the functionality of the library to include touch input.
+Contributions are welcome. Please open an issue or submit a pull request on GitHub. We are particularly interested in contributions that would extend the functionality of the library to include touch input.