From 401f72bce6045d24b4f2128d81edf2546652039a Mon Sep 17 00:00:00 2001 From: Suraj Deore Date: Thu, 31 Oct 2024 10:25:09 +0530 Subject: [PATCH] remove unnecesary file --- dev_setup.md | 59 ---------------------------------------------------- 1 file changed, 59 deletions(-) delete mode 100644 dev_setup.md diff --git a/dev_setup.md b/dev_setup.md deleted file mode 100644 index 1235c2e..0000000 --- a/dev_setup.md +++ /dev/null @@ -1,59 +0,0 @@ -# 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. - -## Setup - -* You need a suitable version of Python3 (3.8 <= Python3 <= 3.12). You - can install this from your package manager. On Debian the package is - called `python3`. - -* You also need an executable `cvc5` binary on your PATH. Download the - appropriate version from - 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 - ``` - -## 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).