Skip to content

Commit

Permalink
Update generated content
Browse files Browse the repository at this point in the history
  • Loading branch information
lkdvos committed Dec 2, 2024
1 parent 1395986 commit 11d4eeb
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 19 deletions.
26 changes: 13 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).*
Expand Down
18 changes: 12 additions & 6 deletions examples/README.jl
Original file line number Diff line number Diff line change
Expand Up @@ -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.

0 comments on commit 11d4eeb

Please sign in to comment.