Skip to content

Commit 616aa4c

Browse files
authored
Update installation instructions (#23)
1 parent c88a0db commit 616aa4c

File tree

4 files changed

+48
-21
lines changed

4 files changed

+48
-21
lines changed

README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -9,31 +9,31 @@
99

1010
## Installation instructions
1111

12+
This package resides in the `ITensor/ITensorRegistry` local registry.
13+
In order to install, simply add that registry through your package manager.
14+
This step is only required once.
15+
1216
```julia
1317
julia> using Pkg: Pkg
1418

15-
julia> Pkg.add(url="https://github.com/ITensor/ITensorPkgSkeleton.jl")
19+
julia> Pkg.Registry.add(url="https://github.com/ITensor/ITensorRegistry")
1620
```
1721

18-
## Examples
22+
Then, the package can be added as usual through the package manager:
1923

20-
````julia
21-
using ITensorPkgSkeleton: ITensorPkgSkeleton
22-
````
23-
24-
This step might be required to circumvent issues with
25-
the version of git installed by `Git.jl`.
2624

27-
````julia
28-
ITensorPkgSkeleton.use_system_git!()
29-
````
25+
```julia
26+
julia> Pkg.add("ITensorPkgSkeleton")
27+
```
3028

31-
If `path` isn't specified, it defaults to `~/.julia/dev`.
29+
## Examples
3230

3331
````julia
34-
ITensorPkgSkeleton.generate("NewPkg"; path=mktempdir())
32+
using ITensorPkgSkeleton: ITensorPkgSkeleton
3533
````
3634

35+
Examples go here.
36+
3737
---
3838

3939
*This page was generated using [Literate.jl](https://github.com/fredrikekre/Literate.jl).*

examples/README.jl

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,19 +9,25 @@
99

1010
# ## Installation instructions
1111

12+
# This package resides in the `ITensor/ITensorRegistry` local registry.
13+
# In order to install, simply add that registry through your package manager.
14+
# This step is only required once.
1215
#=
1316
```julia
1417
julia> using Pkg: Pkg
1518
16-
julia> Pkg.add(url="https://github.com/ITensor/ITensorPkgSkeleton.jl")
19+
julia> Pkg.Registry.add(url="https://github.com/ITensor/ITensorRegistry")
20+
```
21+
=#
22+
# Then, the package can be added as usual through the package manager:
23+
24+
#=
25+
```julia
26+
julia> Pkg.add("ITensorPkgSkeleton")
1727
```
1828
=#
1929

2030
# ## Examples
2131

2232
using ITensorPkgSkeleton: ITensorPkgSkeleton
23-
# This step might be required to circumvent issues with
24-
# the version of git installed by `Git.jl`.
25-
ITensorPkgSkeleton.use_system_git!()
26-
# If `path` isn't specified, it defaults to `~/.julia/dev`.
27-
ITensorPkgSkeleton.generate("NewPkg"; path=mktempdir())
33+
# Examples go here.

templates/docs/README.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,21 @@
99

1010
## Installation instructions
1111

12+
This package resides in the `ITensor/ITensorRegistry` local registry.
13+
In order to install, simply add that registry through your package manager.
14+
This step is only required once.
15+
1216
```julia
1317
julia> using Pkg: Pkg
1418

15-
julia> Pkg.add(url="https://github.com/ITensor/{PKGNAME}.jl")
19+
julia> Pkg.Registry.add(url="https://github.com/ITensor/ITensorRegistry")
20+
```
21+
22+
Then, the package can be added as usual through the package manager:
23+
24+
25+
```julia
26+
julia> Pkg.add("{PKGNAME}")
1627
```
1728

1829
## Examples

templates/examples/examples/README.jl

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,21 @@
99

1010
# ## Installation instructions
1111

12+
# This package resides in the `ITensor/ITensorRegistry` local registry.
13+
# In order to install, simply add that registry through your package manager.
14+
# This step is only required once.
1215
#=
1316
```julia
1417
julia> using Pkg: Pkg
1518
16-
julia> Pkg.add(url="https://github.com/ITensor/{PKGNAME}.jl")
19+
julia> Pkg.Registry.add(url="https://github.com/ITensor/ITensorRegistry")
20+
```
21+
=#
22+
# Then, the package can be added as usual through the package manager:
23+
24+
#=
25+
```julia
26+
julia> Pkg.add("{PKGNAME}")
1727
```
1828
=#
1929

0 commit comments

Comments
 (0)