search

snorben / EEG_preprocessing_UMCU

Apache License 2.0
1 stars 0 forks source link

Next step: Enable Zenodo integration #9

Open github-actions[bot] opened 4 months ago

github-actions[bot] commented 4 months ago

By enabling Zenodo integration, your package will automatically get a DOI which can be used to cite your package. After enabling Zenodo integration for your GitHub repository, Zenodo will create a snapshot and archive each release you make on GitHub. Moreover, Zenodo will create a new DOI for each GitHub release of your code.

To enable Zenodo integration:

  1. Go to http://zenodo.org and login with your GitHub account. When you are redirected to GitHub, Authorize application to give permission to Zenodo to access your account.
  2. Go to https://zenodo.org/account/settings/github/ and enable Zenodo integration of your repository by clicking on On toggle button.
  3. Your package will get a DOI only after you make a release. Create a new release as described in README.dev.md
  4. At this point you should have a DOI. To find out the DOI generated by Zenodo:
    1. Visit https://zenodo.org/deposit and click on your repository link
    2. You will find the latest DOI in the right column in Versions box in Cite all versions? section
    3. Copy the text of the link. For example 10.5281/zenodo.1310751

  5. Update the badge in your repository

    1. Edit README.md and replace the badge placeholder with the badge link you copied in previous step. The badge placeholder is shown below.

      [![DOI](https://zenodo.org/badge/DOI/<replace-with-created-DOI>.svg)](https://doi.org/<replace-with-created-DOI>)

For FAQ about Zenodo please visit https://help.zenodo.org/.