update README instructions

ITensor · Dec 19, 2024 · 5151177 · 5151177
1 parent a363da9
commit 5151177
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 18 deletions.
diff --git a/README.md b/README.md
@@ -9,20 +9,24 @@
 
 ## 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/BroadcastMapConversion.jl")
-
-julia> Pkg.add(url="https://github.com/ITensor/NestedPermutedDimsArrays.jl")
-
-julia> Pkg.add(url="https://github.com/ITensor/TypeParameterAccessors.jl")
-
-julia> Pkg.add(url="https://github.com/ITensor/SparseArraysBase.jl")
+julia> Pkg.Registry.add(url="https://github.com/ITensor/ITensorRegistry")
+```
+or:
+```julia
+julia> Pkg.Registry.add(url="git@github.com:ITensor/ITensorRegistry.git")
+```
+if you want to use SSH credentials, which can make it so you don't have to enter your Github ursername and password when registering packages.
 
-julia> Pkg.add(url="https://github.com/ITensor/TensorAlgebra.jl")
+Then, the package can be added as usual through the package manager:
 
-julia> Pkg.add(url="https://github.com/ITensor/NamedDimsArrays.jl")
+```julia
+julia> Pkg.add("NamedDimsArrays")
 ```
 
 ## Examples

diff --git a/examples/README.jl b/examples/README.jl
@@ -9,21 +9,29 @@
 
 # ## 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/BroadcastMapConversion.jl")
-
-julia> Pkg.add(url="https://github.com/ITensor/NestedPermutedDimsArrays.jl")
-
-julia> Pkg.add(url="https://github.com/ITensor/TypeParameterAccessors.jl")
-
-julia> Pkg.add(url="https://github.com/ITensor/SparseArraysBase.jl")
+julia> Pkg.Registry.add(url="https://github.com/ITensor/ITensorRegistry")
+```
+=#
+# or:
+#=
+```julia
+julia> Pkg.Registry.add(url="[email protected]:ITensor/ITensorRegistry.git")
+```
+=#
+# if you want to use SSH credentials, which can make it so you don't have to enter your Github ursername and password when registering packages.
 
-julia> Pkg.add(url="https://github.com/ITensor/TensorAlgebra.jl")
+# Then, the package can be added as usual through the package manager:
 
-julia> Pkg.add(url="https://github.com/ITensor/NamedDimsArrays.jl")
+#=
+```julia
+julia> Pkg.add("NamedDimsArrays")
 ```
 =#