From 616aa4c0cb15f9241890b76bc4d255e2e365cfd2 Mon Sep 17 00:00:00 2001 From: Lukas Devos Date: Mon, 2 Dec 2024 19:10:51 -0500 Subject: [PATCH] Update installation instructions (#23) --- README.md | 26 +++++++++++++------------- examples/README.jl | 18 ++++++++++++------ templates/docs/README.md | 13 ++++++++++++- templates/examples/examples/README.jl | 12 +++++++++++- 4 files changed, 48 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index 07bb2d0..a345b97 100644 --- 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 index 5f426b7..6da4d13 100644 --- 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 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}") ``` =#