Skip to content

add compatibility warning to README #636

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
aviatesk merged 2 commits into from
Apr 11, 2025
Merged

add compatibility warning to README #636

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c6e9cb6
add compatibility warning to README
aviatesk Apr 11, 2025
f0d2630
add note for nightly users
aviatesk Apr 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 21 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,26 @@
# Cthulhu.jl [![CI](https://github.com/JuliaDebug/Cthulhu.jl/actions/workflows/CI.yml/badge.svg)](https://github.com/JuliaDebug/Cthulhu.jl/actions/workflows/CI.yml)

*The slow descent into madness*

:warning: The latest stable version is only compatible with Julia v1.8.5 and higher.
> *The slow descent into madness*

> [!warning]
> This package relies on internal APIs of the Julia base compiler.
> As such, its behavior may change depending on your Julia version.
> For maintenance reasons, the latest version of Cthulhu (typically managed in the `master`
> branch) does not guarantee compatibility with older Julia versions.
> Versions of Cthulhu compatible with earlier Julia releases may be maintained in dedicated branches[^old-version-branch-ex].
>
> Please refer to the `Project.toml` file for details on supported Julia versions.
> Generally, Julia's package manager automatically selects a compatible Cthulhu version for
> your Julia installation.
> If you simply want to use Cthulhu, running `pkg> add Cthulhu` will install an appropriate version.
>
> **Note for nightly users:**
> If you're using the latest Julia nightly build, we recommend regularly checking that your
> Cthulhu installation is up-to-date (`pkg> update Cthulhu`) to have compatibility with
> recent internal changes.

[^old-version-branch-ex]: For example, Cthulhu code compatible with Julia v1.10 and v1.11 is
maintained in the [`2.16`](https://github.com/JuliaDebug/Cthulhu.jl/tree/2.16) branch.

Cthulhu can help you debug type inference issues by recursively showing the
type-inferred code until you find the exact point where inference gave up,
Expand Down
Loading