Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
hverhelst authored Jan 9, 2025
1 parent 421233d commit 953a731
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,13 @@
[![Build Status](https://github.com/gismo/Gismo.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/gismo/Gismo.jl/actions/workflows/CI.yml?query=branch%3Amain)
![GitHub Downloads (all assets, all releases)](https://img.shields.io/github/downloads/JuliaBinaryWrappers/gismo_jll.jl/total?label=Downloads%20(gismo_jll)&color=008A00)
![GitHub Downloads (all assets, all releases)](https://img.shields.io/github/downloads/gismo/Gismo.jl/total?label=Downloads%20(Gismo.jl)&color=008A00)

|Gismo.jl||
|--:|---|
|License|![GitHub License](https://img.shields.io/github/license/gismo/gismo?color=008A00)|
|OS support|Linux, Windows, macOS|
|Build status|[![ci](https://github.com/gismo/gsKLShell/actions/workflows/ci.yml/badge.svg)](https://github.com/gismo/gsKLShell/actions/workflows/ci.yml)|
|Developers/maintainers| [![Static Badge](https://img.shields.io/badge/@hverhelst-008A00)](https://github.com/hverhelst) [![Static Badge](https://img.shields.io/badge/@Albe21072000-008A00)](https://github.com/Albe21072000)|
|Activity|![GitHub commits since latest release](https://img.shields.io/github/commits-since/gismo/Gismo.jl/latest?color=008A00) ![GitHub commit activity](https://img.shields.io/github/commit-activity/m/gismo/Gismo.jl?color=008A00)|

# Gismo.jl: Geometry + Simulation Modules meet Julia
The Gismo.jl package provides an interface to the [Geometry + Simulation Modules](https://github.com/gismo/gismo) inside Julia.
Expand Down

6 comments on commit 953a731

@hverhelst
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
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 created: JuliaRegistries/General/122684

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 v25.1.0 -m "<description of version>" 953a731386b3a57ddaaaa604f1d6decb7d129d97
git push origin v25.1.0

Also, note the warning: Version 25.1.0 skips over 1.0.0
This can be safely ignored. However, if you want to fix this you can do so. Call register() again after making the fix. This will update the Pull request.

@hverhelst
Copy link
Member Author

@hverhelst hverhelst commented on 953a731 Jan 9, 2025

Choose a reason for hiding this comment

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

@JuliaRegistrator register [merge approved]

Release notes:

This is the first official release of Gismo.jl!

  • It adds support for the following features of G+Smo:
    • Quadrature rule
    • HB-splines
    • OptionList
    • Spline fitting
  • It changes the style of function that modify their input, using the !-syntax
  • It adds doc tests, unit tests and documentation

Breaking changes

  • Change from Gismo.eval to val
  • Change to the style of function that modify their input, using the !-syntax

In case of bugs or comments, reach out to @hverhelst or @Albe21072000

@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/122684

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 v25.1.0 -m "<description of version>" 953a731386b3a57ddaaaa604f1d6decb7d129d97
git push origin v25.1.0

Also, note the warning: Version 25.1.0 skips over 1.0.0
This can be safely ignored. However, if you want to fix this you can do so. Call register() again after making the fix. This will update the Pull request.

@hverhelst
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 [merge approved]

Release notes:

This is the first official release of Gismo.jl!

  • It adds support for the following features of G+Smo:
    • Quadrature rule
    • HB-splines
    • OptionList
    • Spline fitting
  • It changes the style of function that modify their input, using the !-syntax
  • It adds doc tests, unit tests and documentation

Breaking changes

  • Change from Gismo.eval to val
  • Change to the style of function that modify their input, using the !-syntax

In case of bugs or comments, reach out to @hverhelst or @Albe21072000

@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/122684

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 v25.1.0 -m "<description of version>" 953a731386b3a57ddaaaa604f1d6decb7d129d97
git push origin v25.1.0

Also, note the warning: Version 25.1.0 skips over 1.0.0
This can be safely ignored. However, if you want to fix this you can do so. Call register() again after making the fix. This will update the Pull request.

Please sign in to comment.