Update installation instructions

ITensor · Dec 2, 2024 · 1395986 · 1395986
1 parent c88a0db
commit 1395986
Show file tree

Hide file tree

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