diff options
| author | Andrzej Janik <[email protected]> | 2021-01-08 17:17:46 +0100 |
|---|---|---|
| committer | GitHub <[email protected]> | 2021-01-08 17:17:46 +0100 |
| commit | 078ae20c2c0aff93858eeb69d0c46dad4d997998 (patch) | |
| tree | 38d2313c5bab64e2a84c90a219bd60ce6808f116 /CONTRIBUTING.md | |
| parent | 2c0e9b912fe341bd1e513614014fa43b666d257d (diff) | |
| download | ZLUDA-078ae20c2c0aff93858eeb69d0c46dad4d997998.tar.gz ZLUDA-078ae20c2c0aff93858eeb69d0c46dad4d997998.zip | |
Improve build procedure and instructions (#28)
Fixes issues pointed out in #27:
* spirv_tools-sys was build in non-test profiles
* By default ZLUDA dll has a wrong name
* We relied on third-party OpenCL installation on Windows
* We encouraged building debug configuration
* We didn't provide build information for developers (cmake, python, submodules)
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..fe467d1 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,18 @@ +## Dependencies
+
+Development builds of ZLUDA requires following dependencies:
+
+* CMake
+* Python 3
+
+Additionally repository have to be clone with Git submodules initalized. If you cloned the repo without initalizing submodules, do this:
+```
+git submodule update --init --recursive
+```
+
+## Tests
+
+Tests should be executed with `--workspace` option to test non-default targets:
+```
+cargo test --workspace
+```
|