Skip to content

Commit ed767b6

Browse files
authored
Add some installation tips to docs/README.md (#2326)
[skip tests]
1 parent 5da4d1d commit ed767b6

File tree

2 files changed

+12
-2
lines changed

2 files changed

+12
-2
lines changed

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,11 @@ kernels in Julia, and wrappers for various CUDA libraries.
3434

3535
The latest development version of CUDA.jl requires **Julia 1.8** or higher. If you are using
3636
an older version of Julia, you need to use a previous version of CUDA.jl. This will happen
37-
automatically when you install the package using Julia's package manager.
37+
automatically when you install the package using Julia's package manager.
38+
39+
Note that CUDA.jl may not work with a custom build of Julia; it is recommended that you
40+
install Julia using the [official binaries](https://julialang.org/downloads/) or
41+
[juliaup](https://github.com/JuliaLang/juliaup).
3842

3943
CUDA.jl currently also requires a CUDA-capable GPU with **compute capability 3.5** (Kepler)
4044
or higher, and an accompanying NVIDIA driver with support for **CUDA 11.0** or newer. These
@@ -49,7 +53,6 @@ Depending on your system and GPU, you may need to install an older version of th
4953
Finally, you should be using a platform **supported by NVIDIA**. Currently, that means using
5054
64-bit Linux or Windows, with an X86, ARM, or PowerPC host processor.
5155

52-
5356
## Quick start
5457

5558
Before all, make sure you have a recent NVIDIA driver. On Windows, also make sure you have

docs/src/faq.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,3 +56,10 @@ their exported submodule handles, e.g., `CUBLAS.cublasGetVersion_v2`.
5656
Any help on designing or implementing high-level wrappers for this low-level functionality
5757
is greatly appreciated, so please consider contributing your uses of these APIs on the
5858
respective repositories.
59+
60+
61+
## When installing CUDA.jl on a cluster, why does Julia stall during precompilation?
62+
63+
If you're working on a cluster, precompilation may stall if you have not requested
64+
sufficient memory. You may also wish to make sure you have enough disk space prior
65+
to installing CUDA.jl.

0 commit comments

Comments
 (0)