Skip to content

Publish the library on MATLAB File Exchange linked to GitHub #4

@dcajal

Description

@dcajal

Description:

We aim to facilitate the public use of biosigmat by making it installable via MATLAB File Exchange, eliminating the need for manual cloning or path management.

Decision:
We will use MATLAB File Exchange linked to this GitHub repository. This gives us the following advantages:

  • Keep GitHub as the development and version control source.
  • Expose only the src/ folder to end users.
  • Enable installation directly from MATLAB or via double-click.
  • Manage versions using GitHub Releases.
  • Support .mltbx toolbox packaging for one-click installation and compatibility with the MATLAB Add-On Manager.

We will also generate a .mltbx (Toolbox) file that can be:

  • Installed manually by users.
  • Uploaded to File Exchange.
  • Optionally attached to GitHub Releases for versioned distribution.

Tasks:

  • Ensure src/ is clean and organized.
  • Create the .mltbx file using MATLAB’s "Package Toolbox" interface.
  • Fill in metadata: name, version, author, license, and description.
  • Link this repository to a new File Exchange entry.
  • Configure File Exchange to detect new GitHub releases.
  • Add installation instructions in the README.

References:

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationenhancementNew feature or request

    Type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions