diff --git a/templates/docs/README.md b/templates/docs/README.md index e9c7fc5..3183c48 100644 --- a/templates/docs/README.md +++ b/templates/docs/README.md @@ -9,10 +9,21 @@ ## Installation instructions +This package 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> Pkg.add(url="https://github.com/ITensor/{PKGNAME}.jl") +julia> Pkg.Registry.add(url="https://github.com/ITensor/ITensorRegistry") +``` + +Then, the package can be added as usual through the package manager: + + +```julia +julia> Pkg.add("{PKGNAME}") ``` ## Examples diff --git a/templates/examples/examples/README.jl b/templates/examples/examples/README.jl index 0d60358..abfc371 100644 --- a/templates/examples/examples/README.jl +++ b/templates/examples/examples/README.jl @@ -9,11 +9,21 @@ # ## Installation instructions +# This package 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> Pkg.add(url="https://github.com/ITensor/{PKGNAME}.jl") +julia> Pkg.Registry.add(url="https://github.com/ITensor/ITensorRegistry") +``` +=# +# Then, the package can be added as usual through the package manager: + +#= +```julia +julia> Pkg.add("{PKGNAME}") ``` =#