To name the root folder of your toolbox, shorten the English name by removing the word "toolbox" and start with a letter.When you are working in GitHub, this is the repository name, and will be the name of the folder when the repository is cloned. This folder has everything a developer needs to collaborate with you on your toolbox. TopicsĪt the top level of your project is a folder or source repository, which we'll call the root folder. If you'd like to explore a complete toolbox that uses this structure, visit the Climate Data Store Toolbox.
#CHECK MATLAB TOOLBOXES INSTALLED HOW TO#
We’ll use this throughout to show how to apply these design principles. To make it easier to follow, we’ve created a fictitious toolbox for doing basic arithmetic: The Arithmetic Toolbox on GitHub. There’s no need to do everything all at once - you can start with a few guidelines and adopt more as you go. We will step through a comprehensive example with many aspects. The guidelines we present can be adapted for toolboxes that are large or small, casual or sophisticated. Some toolboxes will be just a few files others may be extensive and represent years of effort by multiple people.
#CHECK MATLAB TOOLBOXES INSTALLED CODE#
Toolboxes contain not just code files, but also data, apps, tests, and examples. We use the term “toolbox” here to mean a collection of reusable MATLAB code that you want to share with other people. Tools and systems (such as automated testing on GitHub) will immediately know how to work. Standard formats also make it easier for you to maintain the toolbox. These and other best practices help your users build confidence that your toolbox is well built and ready to use.īut the advantages go beyond helping your users. They also know that a good place to start learning how to use your toolbox will be the gettingStarted.mlx file. They know, for example, that they can always expect to find a helpful and thorough README.md file in the top folder. Your work is more "legible," because it's in a familiar format.
We plan to address those in the future.īeing in a standard format makes it easier for other people to assess and take advantage of your work. Right now, we're focused on toolboxes that don't have derived files that require a build step, like MEX files or content-obscured files (P-Code).
Your insights and feedback help us improve this document and make it even more useful for the community. Feel free to open an issue or post to the discussions. We encourage your feedback and suggestions for future revisions. This is a continuously evolving document and some best practices may change in the future as MATLAB evolves. It's a little bit of extra work with a big payoff. To do that, we want to convince you to use the MathWorks Toolbox best practices. You have a MATLAB® toolbox that you want to share with the world.
0 kommentar(er)
