Skip to content

Publishing your Project for Delphinus

Alexander Benikowski edited this page Nov 28, 2018 · 37 revisions

Requirements

To publish your project for Delphinus you need to:

  • put it on GitHub (see Alternative if on Bitbucket)
    • ⚠️ It must be the "original" repository. Repositories marked as "fork" are not listed to avoid flooding
  • add an Delphinus.Info.json to the repository root
  • add an Delphinus.Install.json to the repository root
  • add at least one version (optional) see: Versioning your package
  • add "Delphinus-Support" (without quotes) to your readme within your repository
    • ⚠️ </br> tags in readme can cause that package will be invisible for Delphinus.
    • ⚠️ add the topic delphinuspackage to the repository as i plan to deprecate the Readme way and use topics for searching. By adding the topic in addition to the readme entry, you prepare your repository for future changes! If you setup the topic correctly, your repo will appear on https://github.com/topics/delphinuspackage

Alternative or how to link to Bitbucket

Instead of putting the Delphinus files directly into your repository, you can put them in a seperate one and link to the source repository. See External Timelines