Skip to content
Joe Wallwork edited this page Apr 15, 2024 · 2 revisions

Great to hear that you have made use of Animate, Goalie, and/or Movement in your research! Thank you for citing the software and supporting open source software.

Instructions for creating a release for one of the packages

For the purpose of this section, let's refer to whichever of Animate, Goalie, and Movement you want to cite as <package>.

  1. Go to https://github.com/mesh-adaptation/<package>.
  2. Click "create a new release" on the right hand side.
  3. Select the branch and/or commit you want to release and add a title and description.
  4. Create a tag for your release using the drop-down menu. We recommend creating a new tag with the format <Package>_YYYYMMDD, e.g., Animate_20240415.
  5. Make an actual release (not a pre-release) for Zenodo to notice.
  6. Click the green "Publish release" button.

Examples

You can see examples of releases here:

Citing your release

Once the release has been successfully created, head over to Zenodo and search for your tag in the search bar. Hopefully the release should appear in the search results. Click it to see the contents, including a DOI badge in the "Details" section and a citation in the "Citation" section.

Clone this wiki locally