Skip to content

Commit a4ab687

Browse files
authored
Update installation instructions (#8)
1 parent a363da9 commit a4ab687

File tree

2 files changed

+30
-18
lines changed

2 files changed

+30
-18
lines changed

README.md

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,20 +9,24 @@
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
```julia
1316
julia> using Pkg: Pkg
1417

15-
julia> Pkg.add(url="https://github.com/ITensor/BroadcastMapConversion.jl")
16-
17-
julia> Pkg.add(url="https://github.com/ITensor/NestedPermutedDimsArrays.jl")
18-
19-
julia> Pkg.add(url="https://github.com/ITensor/TypeParameterAccessors.jl")
20-
21-
julia> Pkg.add(url="https://github.com/ITensor/SparseArraysBase.jl")
18+
julia> Pkg.Registry.add(url="https://github.com/ITensor/ITensorRegistry")
19+
```
20+
or:
21+
```julia
22+
julia> Pkg.Registry.add(url="git@github.com:ITensor/ITensorRegistry.git")
23+
```
24+
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.
2225

23-
julia> Pkg.add(url="https://github.com/ITensor/TensorAlgebra.jl")
26+
Then, the package can be added as usual through the package manager:
2427

25-
julia> Pkg.add(url="https://github.com/ITensor/NamedDimsArrays.jl")
28+
```julia
29+
julia> Pkg.add("NamedDimsArrays")
2630
```
2731

2832
## Examples

examples/README.jl

Lines changed: 17 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,21 +9,29 @@
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/BroadcastMapConversion.jl")
17-
18-
julia> Pkg.add(url="https://github.com/ITensor/NestedPermutedDimsArrays.jl")
19-
20-
julia> Pkg.add(url="https://github.com/ITensor/TypeParameterAccessors.jl")
21-
22-
julia> Pkg.add(url="https://github.com/ITensor/SparseArraysBase.jl")
19+
julia> Pkg.Registry.add(url="https://github.com/ITensor/ITensorRegistry")
20+
```
21+
=#
22+
# or:
23+
#=
24+
```julia
25+
julia> Pkg.Registry.add(url="[email protected]:ITensor/ITensorRegistry.git")
26+
```
27+
=#
28+
# 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.
2329

24-
julia> Pkg.add(url="https://github.com/ITensor/TensorAlgebra.jl")
30+
# Then, the package can be added as usual through the package manager:
2531

26-
julia> Pkg.add(url="https://github.com/ITensor/NamedDimsArrays.jl")
32+
#=
33+
```julia
34+
julia> Pkg.add("NamedDimsArrays")
2735
```
2836
=#
2937

0 commit comments

Comments
 (0)