Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
lkdvos committed Nov 29, 2024
1 parent 9f79ebf commit 3aa1e77
Showing 1 changed file with 8 additions and 6 deletions.
14 changes: 8 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,18 @@ tensors and allocating as little data as possible.

## Installation instructions

This package resides in the `ITensor/JuliaRegistry` 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/TypeParameterAccessors.jl")

julia> Pkg.add(url="https://github.com/ITensor/UnspecifiedTypes.jl")
julia> Pkg.Registry.add(url="https://github.com/ITensor/JuliaRegistry")
```
Then, the package can be added as usual through the package manager:

julia> Pkg.add(url="https://github.com/ITensor/UnallocatedArrays.jl")
```julia
julia> Pkg.add("UnallocatedArrays")
```

## Examples
Expand All @@ -28,8 +32,6 @@ julia> Pkg.add(url="https://github.com/ITensor/UnallocatedArrays.jl")
using UnallocatedArrays: UnallocatedArrays
````

Examples go here.

---

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

0 comments on commit 3aa1e77

Please sign in to comment.