Mhirsch-wip #32
Mhirsch-wip #32
Conversation
…oot Folder section First pass of updates: * updated gettingStarted.mlx to GettingStarted.mlx to math standard that example files use Upper Camelcase Names * Renamed Root Folder to Root Folder Name and Contents to set a clearer expectation of what would be included.
Starting to work on updates for 25a toolbox packaging workflow.
…ually keeps functions off of the path
|
@michellehirsch Per our in-person conversation:
|
|
@rpurser47 and @bpancras to review the proposed R2025a project based toolbox packaging workflow recommendation. |
|
Addressed Rob's feedback. |
…l to hide internal functionality.
…led actions, but also attempted to clean up a few other parts.
There was a problem hiding this comment.
Have made all requested changes. Ready for @rpurser47 to review again.
|
|
||
| The information about your toolbox is stored in a toolbox packaging file. Confusingly, this file has a `.prj` extension -- the same as a MATLAB project file. These files are not interchangeable. Because of this, we recommend that you name your packaging file `toolboxPackaging.prj` and put it in the root folder. To make it clear which icon image file will be used, we recommend that you symmetrically name this file `toolboxPackaging.jpg` and put it in the `images` folder. These files should be under source control. | ||
| Note that the tools for packaging a toolbox changed in R2025a: | ||
| * Starting in R2025a, Toolbox packaging files are created using the Package Toolbox task with MATLAB Projects. Give the project file (with a `.prj` extension) the same name as the root folder. Put it in the root folder. |
There was a problem hiding this comment.
I think we need to be more step by step about how to do this. I don't think "the Package Toolbox task with MATLAB Projects" will mean much to most people, especially if they don't have a project. I think the easiest way (which works both before and after R2025a) is to go to the Home tab, and in the Environment section, select Add-Ons > Package Toolbox. If they don't have a project, it'll be created for them.
|
|
||
| Toolbox packaging files are created using the Toolbox Packaging Tool. In MATLAB, go to the home tab, drop the "Add-Ons" menu, and choose "Package Toolbox." | ||
| Name your toolbox icon image file `toolboxPackaging.jpg` and put it in the `images` folder. The project files and toolbox icon image file should be under source control. |
There was a problem hiding this comment.
Probably not worth changing, but I'd suggest that they name the image the same as the root folder and the project file.
README.md Updates for ease of use, new features, and slight changes to recommendations.
Ease of use:
New features:
Updates to recommendations: