Update installation instructions (#23)

ITensor · Dec 3, 2024 · 616aa4c · 616aa4c
1 parent c88a0db
commit 616aa4c
Show file tree

Hide file tree

Showing 4 changed files with 48 additions and 21 deletions.
diff --git a/README.md b/README.md
@@ -9,31 +9,31 @@
 
 ## 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/ITensorPkgSkeleton.jl")
+julia> Pkg.Registry.add(url="https://github.com/ITensor/ITensorRegistry")
 ```
 
-## Examples
+Then, the package can be added as usual through the package manager:
 
-````julia
-using ITensorPkgSkeleton: ITensorPkgSkeleton
-````
-
-This step might be required to circumvent issues with
-the version of git installed by `Git.jl`.
 
-````julia
-ITensorPkgSkeleton.use_system_git!()
-````
+```julia
+julia> Pkg.add("ITensorPkgSkeleton")
+```
 
-If `path` isn't specified, it defaults to `~/.julia/dev`.
+## Examples
 
 ````julia
-ITensorPkgSkeleton.generate("NewPkg"; path=mktempdir())
+using ITensorPkgSkeleton: ITensorPkgSkeleton
 ````
 
+Examples go here.
+
 ---
 
 *This page was generated using [Literate.jl](https://github.com/fredrikekre/Literate.jl).*

diff --git a/examples/README.jl b/examples/README.jl
@@ -9,19 +9,25 @@
 
 # ## 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/ITensorPkgSkeleton.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("ITensorPkgSkeleton")
 ```
 =#
 
 # ## Examples
 
 using ITensorPkgSkeleton: ITensorPkgSkeleton
-# This step might be required to circumvent issues with
-# the version of git installed by `Git.jl`.
-ITensorPkgSkeleton.use_system_git!()
-# If `path` isn't specified, it defaults to `~/.julia/dev`.
-ITensorPkgSkeleton.generate("NewPkg"; path=mktempdir())
+# Examples go here.
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}")
 ```
 =#