update installation instructions in README

ITensor · Dec 2, 2024 · e21a1a1 · e21a1a1
1 parent b160fd1
commit e21a1a1
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 4 deletions.
diff --git 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
@@ -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")
 ```
 =#