Skip to content

Commit

Permalink
installation from a specific branch in home guide
Browse files Browse the repository at this point in the history
  • Loading branch information
youwuyou committed Jul 15, 2024
1 parent 2825fcf commit 9192a5f
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,12 @@ After the package is installed, one can load the package by using:
using Chmy
```

!!! info "Install from a Specific Branch"
For developers and advanced users, one might want to use the implementation of Chmy.jl from a specific branch by specifying the url. In the following code snippet, we do this by explicitly specifying to use the current implementation that is available under the `main` branch:

```julia
using Pkg; Pkg.add(url="https://github.com/PTsolvers/Chmy.jl#main")
```

## Feature Summary

Expand Down

0 comments on commit 9192a5f

Please sign in to comment.