Skip to content

Commit 653ef75

Browse files
committed
Add troubleshooting section to README
1 parent 9a837d9 commit 653ef75

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

README.md

+9
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,14 @@ Create a 5-by-3 matrix of random floats on the GPU
8282
...
8383
```
8484

85+
### Troubleshooting
86+
87+
If the build command fails with undefined references errors even after taking care of environment
88+
variables, we recommend doing a `cargo clean` and re-running `cargo build` or `cargo test`.
89+
90+
You can also use some environment variables mentioned in our [book][23], such as `AF_PRINT_ERRORS`
91+
to print more elaborate error messages to console.
92+
8593
## Acknowledgements
8694

8795
The ArrayFire library is written by developers at [ArrayFire][14] LLC with [contributions][15]
@@ -118,3 +126,4 @@ the DARPA SBIR Program Office.
118126
[20]: https://img.shields.io/badge/arrayfire-google--groups-orange
119127
[21]: http://arrayfire.org/arrayfire-rust/book/index.html
120128
[22]: https://img.shields.io/badge/arrayfire-mdbook-073763?logo=readthedocs
129+
[23]: http://arrayfire.org/arrayfire-rust/book/configuring_arrayfire_environment.html

0 commit comments

Comments
 (0)