Skip to content

Commit

Permalink
chore: add julia version warning
Browse files Browse the repository at this point in the history
  • Loading branch information
mmolari committed Oct 30, 2023
1 parent 0881676 commit b11ef76
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 1 deletion.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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

Expand Down
3 changes: 2 additions & 1 deletion docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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

Expand Down

0 comments on commit b11ef76

Please sign in to comment.