Skip to content

Commit

Permalink
Have read me reflect that Subzero isn't registered yet
Browse files Browse the repository at this point in the history
  • Loading branch information
skygering authored Sep 26, 2024
1 parent be0ed10 commit 8f3fa53
Showing 1 changed file with 10 additions and 4 deletions.
14 changes: 10 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 "[email protected]: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_
Expand Down

0 comments on commit 8f3fa53

Please sign in to comment.