Skip to content

Commit

Permalink
updated greadme again
Browse files Browse the repository at this point in the history
  • Loading branch information
@jagoosw
jagoosw committed Dec 24, 2023
1 parent 24bd889 commit 5682aa1
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Currently, it includes:
- `WindStress`: a bulk formulation for wind stress
- `SurfaceHeatExchange`: a bulk formulation for heat exchange at the ocean surface

Limited documentaiton is available [here](http://walrus.jagosw.com/dev/).
Details of the parametrisations used for each model and implementation notes can be found in their docstrings and in [the documentation](https://walrus.jagosw.com/stable/appendix/library/).

To-do:
- Add automated testing
Expand Down

2 comments on commit 5682aa1

@jagoosw
Copy link
Owner 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/97694

Tip: Release Notes

Did you know you can add release notes too? Just add markdown formatted text underneath the comment after the text
"Release notes:" and it will be added to the registry PR, and if TagBot is installed it will also be added to the
release that TagBot creates. i.e.

@JuliaRegistrator register

Release notes:

## Breaking changes

- blah

To add them here just re-invoke and the PR will be updated.

Tagging

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.4.0 -m "<description of version>" 5682aa16ece72f55c0310922bea310f841f17eab
git push origin v0.4.0

Please sign in to comment.