📚 added compatible information

HOQST requires Julia 1.4 or higher.
USCqserver · Dec 11, 2020 · c5df0ca · c5df0ca
1 parent c06b1d7
commit c5df0ca
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -14,10 +14,11 @@ To install, run the following commands inside the Julia REPL:
 using Pkg
 Pkg.add("OpenQuantumTools")
 ```
-This will install the packages directly from their GitHub repos. Alternatively, this can also be done in Julia's [Pkg REPL](https://julialang.github.io/Pkg.jl/v1/getting-started/):
+Alternatively, this can also be done in Julia's [Pkg REPL](https://julialang.github.io/Pkg.jl/v1/getting-started/):
 ```julia-REPL
 (1.5) pkg> add OpenQuantumTools
 ```
+`OpenQuantumTools` requires Julia 1.4 or higher. Installing it on an older version of Julia will result in an unsatisfiable requirements error.
 
 ## Useful Packages
 It is recommended to install the following external packages:  

diff --git a/docs/src/index.md b/docs/src/index.md
@@ -14,11 +14,11 @@ To install, run the following commands inside the Julia REPL:
 using Pkg
 Pkg.add("OpenQuantumTools")
 ```
-This will install the packages directly from their GitHub repos. Alternatively, this can also be done in Julia's [Pkg REPL](https://julialang.github.io/Pkg.jl/v1/getting-started/):
+Alternatively, this can also be done in Julia's [Pkg REPL](https://julialang.github.io/Pkg.jl/v1/getting-started/):
 ```julia-REPL
 (1.5) pkg> add OpenQuantumTools
 ```
-More information about `Julia`'s package manager can be found at [Pkg.jl](https://julialang.github.io/Pkg.jl/v1/).
+More information about `Julia`'s package manager can be found at [Pkg.jl](https://julialang.github.io/Pkg.jl/v1/). `OpenQuantumTools` requires Julia 1.4 or higher. Installing it on an older version of Julia will result in an unsatisfiable requirements error.
 
 To load the package, use the command:
 ```julia