Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update installation instructions #23

Merged
merged 2 commits into from
Dec 3, 2024
Merged

Update installation instructions #23

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1395986
Update installation instructions
lkdvos Dec 2, 2024
11d4eeb
Update generated content
lkdvos Dec 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 13 additions & 13 deletions README.md
View file
Open in desktop
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
View file
Open in desktop
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.
13 changes: 12 additions & 1 deletion templates/docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
12 changes: 11 additions & 1 deletion templates/examples/examples/README.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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}")
```
=#

Expand Down
Loading