|
1 | 1 | # Cthulhu.jl [](https://github.com/JuliaDebug/Cthulhu.jl/actions/workflows/CI.yml) |
2 | 2 |
|
3 | | -*The slow descent into madness* |
4 | | - |
5 | | -:warning: The latest stable version is only compatible with Julia v1.8.5 and higher. |
| 3 | +> *The slow descent into madness* |
| 4 | +
|
| 5 | +> [!warning] |
| 6 | +> This package relies on internal APIs of the Julia base compiler. |
| 7 | +> As such, its behavior may change depending on your Julia version. |
| 8 | +> For maintenance reasons, the latest version of Cthulhu (typically managed in the `master` |
| 9 | +> branch) does not guarantee compatibility with older Julia versions. |
| 10 | +> Versions of Cthulhu compatible with earlier Julia releases may be maintained in dedicated branches[^old-version-branch-ex]. |
| 11 | +> |
| 12 | +> Please refer to the `Project.toml` file for details on supported Julia versions. |
| 13 | +> Generally, Julia's package manager automatically selects a compatible Cthulhu version for |
| 14 | +> your Julia installation. |
| 15 | +> If you simply want to use Cthulhu, running `pkg> add Cthulhu` will install an appropriate version. |
| 16 | +> |
| 17 | +> **Note for nightly users:** |
| 18 | +> If you're using the latest Julia nightly build, we recommend regularly checking that your |
| 19 | +> Cthulhu installation is up-to-date (`pkg> update Cthulhu`) to have compatibility with |
| 20 | +> recent internal changes. |
| 21 | +
|
| 22 | +[^old-version-branch-ex]: For example, Cthulhu code compatible with Julia v1.10 and v1.11 is |
| 23 | + maintained in the [`2.16`](https://github.com/JuliaDebug/Cthulhu.jl/tree/2.16) branch. |
6 | 24 |
|
7 | 25 | Cthulhu can help you debug type inference issues by recursively showing the |
8 | 26 | type-inferred code until you find the exact point where inference gave up, |
|
0 commit comments