From 8f3fa537b8ecbfbaee40593d81168d250499f0ff Mon Sep 17 00:00:00 2001 From: Skylar A Gering Date: Thu, 26 Sep 2024 16:47:38 -0400 Subject: [PATCH] Have read me reflect that Subzero isn't registered yet --- README.md | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index e461e20..ac41a5e 100644 --- a/README.md +++ b/README.md @@ -22,16 +22,22 @@ To learn how to build and run simulations, [check out our documentation and tuto ## _Installation_ -Subzero is a [registered Julia package](https://julialang.org/packages/). So to install it, +Subzero is not yet a [registered Julia package](https://julialang.org/packages/). So to install it, 1. [Download Julia](https://julialang.org/downloads/) (version 1.9 or later). -2. Launch Julia and type +2. Launch Julia and enter into the package manager mode by typing `]` in the terminal. + +3. Run the following ```julia -julia> using Pkg +pkg> add "git@github.com:Caltech-OCTO/Subzero.jl.git" +``` + +This will add the package to your package manager. After that you return to the REPL mode by hitting the backspace and you are ready to use Subzero! -julia> Pkg.add("Subzero") +```julia +julia> using Subzero ``` ## _Citing_