From 2cd132301cb0644b6ddc9925b951b851797c2e58 Mon Sep 17 00:00:00 2001
From: Suraj Deore <suraj.deore@tatatechnologies.com>
Date: Mon, 16 Sep 2024 17:53:30 +0530
Subject: [PATCH] Updated documentation for Windows setup

---
 documentation/dev_setup.md | 72 +++++++++++++++++++++++++-------------
 1 file changed, 48 insertions(+), 24 deletions(-)

diff --git a/documentation/dev_setup.md b/documentation/dev_setup.md
index 1235c2e..0ae1fd5 100644
--- a/documentation/dev_setup.md
+++ b/documentation/dev_setup.md
@@ -1,9 +1,9 @@
 # Development environment setup
-
-To contribute to TRLC you will need to be able to run the
-testsuite. Currently this is only realistic on GNU/Linux, although it
-may be possible to get it to work on other platforms.
-
+ 
+To contribute to TRLC, you will need to be able to run the
+testsuite. Currently, this is only realistic on GNU/Linux and Windows,
+although it may be possible to get it to work on other platforms.
+ 
 ## Setup
 
 * You need a suitable version of Python3 (3.8 <= Python3 <= 3.12). You
@@ -15,45 +15,69 @@ may be possible to get it to work on other platforms.
   https://github.com/cvc5/cvc5/releases/tag/cvc5-1.0.8 and rename
   it. You can also build CVC5 from source if there is no pre-built
   release available for your platform.
-
+ 
 * You need to install the `cvc5` PyPI package, or build it from
   source.
-
-* You need GNU Make. This should be available on all sane GNU/Linux
-  distributions. On Debian the package is called `build-essential`.
-
-* You need to install Graphviz. On Debian the package is called
-  `graphviz`.
-
+  
 * You need to install everything from
   [requirements.txt](../requirements.txt).
-
+ 
 * You also need to make available the relevant parts of lobster. You
   can do this in one of two ways:
-
+ 
   * Check out https://github.com/bmw-software-engineering/lobster and
     put the root of the repo on your `PYTHONPATH`.
-
+ 
   * Install from PyPI, carfully avoiding to install the TRLC
     dependency as that will make things really confusing:
-
+ 
     ```bash
     pip install bmw-lobster-core bmw-lobster-tool-python
     pip install --no-deps bmw-lobster-tool-trlc
-	```
-
+  ```
+ 
+# Linux Setup:
+ 
+  * You need GNU Make. This should be available on all sane GNU/Linux
+    distributions. On Debian the package is called `build-essential`.
+ 
+  * You need to install Graphviz. On Debian the package is called
+    `graphviz`.
+ 
+# Windows Setup
+ 
+  * You need to Install Scoop.
+    * Check out https://scoop.sh/
+ 
+  * Once Scoop is installed, install GNU findutils by running the following command:
+ 
+    ```bash
+    scoop install findutils
+    ```
+  * you need to install GNU Make. You can do this by running the following command:
+ 
+    ```bash
+    scoop install make
+    ```
+  * You need to install Graphviz.
+ 
+    ```bash
+      scoop install Graphviz
+    ```
+ 
 ## Important make targets
-
+ 
 * `make lint` to run pycodestyle and pylint.
-
+ 
 * `make test` to run most tests and show coverage analysis.
-
+ 
 * `make test-all` to run all tests. This is the same as above, except
   we also include a massive test that takes a long time to
   run. Generally this is not worth it, but maybe do it once before you
   push.
-
+ 
 * `make tracing` to build just the LOBSTER report.
-
+ 
 * `make docs` to build all the documentation (including the LRM and
   the LOBSTER report).
+ 
\ No newline at end of file