From b11ef768cb7a5098336f27d19418411795acbe56 Mon Sep 17 00:00:00 2001 From: Marco Molari Date: Mon, 30 Oct 2023 09:57:13 +0100 Subject: [PATCH] chore: add julia version warning --- README.md | 3 +++ docs/src/index.md | 3 ++- 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 392e6ad5..31ee3066 100644 --- a/README.md +++ b/README.md @@ -28,6 +28,8 @@ pangraph is available: For more extended instructions on installation please refer to the [documentation](https://neherlab.github.io/pangraph/#Installation). +**Note:** pangraph was written in **Julia version 1.7.2**. Compatibility more recent versions of Julia is not guaranteed. + ### Julia Library To install pangraph as a julia library in a local environment: @@ -75,6 +77,7 @@ Moreover, for the compilation to work, it is necessary to have [MAFFT](https://m **Note,** it is [recommended by the PackageCompiler.jl documentation](https://julialang.github.io/PackageCompiler.jl/stable/#Installation-instructions) to utilize the officially distributed binaries for Julia, not those distributed by your Linux distribution. As such, compilation may not work if you attempt to do so. +**Note,** pangraph was developed in Julia v.1.7.2. Compatibility with more recent versions of Julia is not guaranteed. ### Optional dependencies diff --git a/docs/src/index.md b/docs/src/index.md index 2681e0cf..aa22e6ea 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -40,7 +40,7 @@ Pangraph is available: ### as a Julia library -The library is written in and thus requires [Julia](https://julialang.org/downloads/) to be installed on your machine. +The library is written in and thus requires [Julia](https://julialang.org/downloads/) to be installed on your machine. (Note: pangraph was developed in Julia v.1.7.2, compatibility with more recent versions is not guaranteed.) To install pangraph as a julia library in a local environment: ```bash @@ -138,6 +138,7 @@ Moreover, for the compilation to work, it is necessary to have [MAFFT](https://m **Note,** it is [recommended by the PackageCompiler.jl documentation](https://julialang.github.io/PackageCompiler.jl/stable/#Installation-instructions) to utilize the officially distributed binaries for Julia, not those distributed by your Linux distribution. As such, compilation may not work if you attempt to do so. +**Note,** pangraph was developed in Julia v.1.7.2. Compatibility with more recent versions of Julia is not guaranteed. ### Optional dependencies