From e21a1a1e7ee743c09e949277d9225c9f3d0dd0a0 Mon Sep 17 00:00:00 2001 From: Lukas Devos Date: Mon, 2 Dec 2024 09:34:48 -0500 Subject: [PATCH] update installation instructions in README --- README.md | 11 +++++++++-- examples/README.jl | 13 +++++++++++-- 2 files changed, 20 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 7dcb306..7981179 100644 --- a/README.md +++ b/README.md @@ -11,10 +11,17 @@ A module defining a set of basic types which are place holders for allocated bit ## Installation instructions +This package currently resides in the `ITensor/ITensorRegistry` local registry. +In order to install, simply add that registry through your package manager. +This step is only required once. ```julia -julia> using Pkg: Pkg +julia> using Pkg: Pkg; +julia> Pkg.Registry.add(url="https://github.com/ITensor/ITensorRegistry.jl") +``` +Then, the package can be added as usual through the package manager: -julia> Pkg.add(url="https://github.com/ITensor/UnspecifiedTypes.jl") +```julia +julia> Pkg.add("UnspecifiedTypes") ``` ## Examples diff --git a/examples/README.jl b/examples/README.jl index 0eda9b8..905a7ca 100644 --- a/examples/README.jl +++ b/examples/README.jl @@ -11,11 +11,20 @@ # ## Installation instructions +# This package currently resides in the `ITensor/ITensorRegistry` local registry. +# In order to install, simply add that registry through your package manager. +# This step is only required once. #= ```julia -julia> using Pkg: Pkg +julia> using Pkg: Pkg; +julia> Pkg.Registry.add(url="https://github.com/ITensor/ITensorRegistry.jl") +``` +=# +# Then, the package can be added as usual through the package manager: -julia> Pkg.add(url="https://github.com/ITensor/UnspecifiedTypes.jl") +#= +```julia +julia> Pkg.add("UnspecifiedTypes") ``` =#