From 9192a5f2d4dbb2cab543d64a23f297670cbafccf Mon Sep 17 00:00:00 2001 From: You Wu Date: Mon, 15 Jul 2024 21:24:29 +0200 Subject: [PATCH] installation from a specific branch in home guide --- docs/src/index.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/src/index.md b/docs/src/index.md index f7ffe8ff..09bae98b 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -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