Skip to content

Commit

Permalink
Updated documentation for Windows setup (#105)
Browse files Browse the repository at this point in the history
Platform-Specific Setup Instructions
 
This update adds separate setup instructions for both Linux and Windows
environments:
 
- Windows: Added steps for installing required tools using the Scoop
package manager, including `findutils` and `make`.

- Linux: Clarified package installation for `build-essential` and
`graphviz` using native package managers.
 
These changes simplify the setup process and ensure compatibility across
platforms for contributors.
  • Loading branch information
SurajBDeore authored Nov 7, 2024
1 parent c732e8a commit 04a3e61
Showing 1 changed file with 42 additions and 9 deletions.
51 changes: 42 additions & 9 deletions documentation/dev_setup.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
# 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. Therefore you need GNU make and GNU findutils.
We do provide setup steps for Windows and Linux.
If you run into any problems on macOS, make sure you install
the latest GNU make version.

## Setup

Expand All @@ -19,12 +21,6 @@ may be possible to get it to work on other platforms.
* 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).

Expand All @@ -42,6 +38,43 @@ may be possible to get it to work on other platforms.
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
```

* You need to install coreutils.

```bash
scoop install coreutils
```

## Important make targets

* `make lint` to run pycodestyle and pylint.
Expand Down

0 comments on commit 04a3e61

Please sign in to comment.