open source: add requirements.txt Also add instructions to README.md, explaining how to get prerequisites. Change-Id: I183242faae5ffc099100b6481f24edabb0a4d73c
diff --git a/README.md b/README.md index 521cba4..0d9a41d 100644 --- a/README.md +++ b/README.md
@@ -30,6 +30,12 @@ ### Prerequisite: +To run TBM you will need Python3 and the packages listed in `requirements.txt`. +You can install the packages with pip: `pip install -r requirements.txt`. + +You will also need the flatbuffers compiler `flatc`. On Debian based distros you +can get it with apt: `sudo apt install flatbuffers-compiler` + The make scripts expect the following environment variables and directory structure: @@ -118,16 +124,16 @@ `make merge-pyi` to merge into all `.py` files, or `make merge-pyi-MOD` to merge into `tbm/MOD.py`. +<!--- BEGIN-INTERNAL --> ### Running tests from shodan -<!--- BEGIN-INTERNAL --> - `make -f integration-tests.mk integration_tests` - most of these tests are actually not very good for integration testing as they take far too long to complete. -<!--- END-INTERNAL --> - `make -f riscv_tests.mk riscv_tests_isa` - run some of the tests from `$ROOTDIR/out/springbok/riscv-tests/isa`. - `make -f riscv_tests.mk riscv_tests_benchmarks` - run the tests from `$ROOTDIR/out/springbok/riscv-tests/benchmarks`. - `make -f riscv_tests.mk riscv_tests` - run the two previous targets. - `make -f riscv_tests.mk benchmarks` - runs the above benchmarks and generates the file `benchmarks.md` with all the results. - `make -f rvv_tests.mk rvv_tests` - run the tests from `$ROOTDIR/out/springbok/rvv_for_tbm/tests/`. +<!--- END-INTERNAL -->
diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..1afdd25 --- /dev/null +++ b/requirements.txt
@@ -0,0 +1,4 @@ +flatbuffers +gzip +jsonschema +pyyaml