Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/djmaxus/matlab-repo-init
Quickstart your public MATLAB repository
https://github.com/djmaxus/matlab-repo-init
ci github-actions github-io-page license matlab release-automation repository semantic-versioning template
Last synced: 2 months ago
JSON representation
Quickstart your public MATLAB repository
- Host: GitHub
- URL: https://github.com/djmaxus/matlab-repo-init
- Owner: djmaxus
- License: bsd-3-clause
- Created: 2024-08-13T21:01:26.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-12-05T16:43:58.000Z (3 months ago)
- Last Synced: 2024-12-05T17:37:35.010Z (3 months ago)
- Topics: ci, github-actions, github-io-page, license, matlab, release-automation, repository, semantic-versioning, template
- Language: MATLAB
- Homepage: https://djmaxus.github.io/matlab-repo-init/
- Size: 19.5 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# MATLAB GitHub Repository [Template](https://github.com/djmaxus/matlab-repo-init)

[](https://uk.mathworks.com/matlabcentral/fileexchange/171364-matlab-repo-init)
[](https://opensource.org/licenses/BSD-3-Clause)Quickstart your public MATLAB repository. Batteries included 🔋
## How to use
First, click [Use this template][github-use-template]
to make your own repository from this template.
Clone your new repository.Then locally:
1. Run [`reset_template`](./reset_template.m) script
2. **Upload your own MATLAB code**
3. Tweak anything else to you liking
4. Commit changes [appropriately][conventional-commits] along the wayThen, in _Settings — Actions — General_ of your repository:
1. "Allow all actions and reusable workflows"
2. "Allow GitHub Actions to create and approve pull requests"Then push the local changes and carry on with the development
of your freshly established public MATLAB project!Please go to repository's [Wiki][wiki] (when it's ready)
for more detailed user manual.Do not hesitate to ask [me](https://djmaxus.github.io/)
for assistance and technical support.\
And everyone is welcome to open
[issues](https://github.com/djmaxus/matlab-repo-init/issues)
to request a feature, enhance the documentation, or report a bug.## Features
- Automated Path initialization on [`startup`](startup.m)
- [Utility functions](util/) for analyzing legacy MATLAB scripts
- [`.gitignore`](.gitignore) for MATLAB/Simulink/Octave
- [MATLAB syntax checks](.github/workflows/matlab-ci.yml)
on pull requests and pushes to `main` branch
- Automated [releases](.github/workflows/release-please.yml)
based on [Conventional Commits](.github/workflows/commitlint.yml)
- [Dependabot](.github/dependabot.yml) for GitHub Actions
- [`README`](README.md) [deployment](.github/workflows/webpage.yml) at [`.github.io/`](https://djmaxus.github.io/matlab-repo-init)
- [BSD 3-Clause](LICENSE) open-source license## References
- [Overview of MATLAB Build Tool](https://mathworks.com/help/matlab/matlab_prog/overview-of-matlab-build-tool.html)
- [User-defined `startup` script for MATLAB](https://mathworks.com/help/matlab/ref/startup.html)
- [`.gitignore` generator](https://gitignore.io)
- [Choosing an Open Source License](https://choosealicense.com/)
- [Conventional Commits][conventional-commits][github-use-template]: https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template
[conventional-commits]: https://www.conventionalcommits.org
[wiki]: https://github.com/djmaxus/matlab-repo-init/wiki