Skip to content

Commit

Permalink
update installation instructions in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
@navidcy
navidcy authored Apr 15, 2021
1 parent 9742ba8 commit 4ed2f63
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -39,10 +39,12 @@ Geophysical Fluid Dynamics on periodic domains using Fourier-based pseudospectra

## Installation

To install, do
To install, use Julia's built-in package manager (accessed by pressing `]` in the Julia REPL command prompt) to add the package and also to instantiate/build all the required dependencies

```julia
] add GeophysicalFlows
julia>]
(v1.5) pkg> add GeophysicalFlows
(v1.5) pkg> instantiate
```

The most recent version of GeophysicalFlows.jl requires Julia v1.5 or later.
Expand Down

2 comments on commit 4ed2f63

@navidcy
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JuliaRegistrator register

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Registration pull request updated: JuliaRegistries/General/34336

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v0.12.0 -m "<description of version>" 4ed2f632dfdd79e67bfa6bd9f6355892a5664ab5
git push origin v0.12.0

Please sign in to comment.