Skip to content

Commit

Permalink
Update REAME.md.
Browse files Browse the repository at this point in the history
  • Loading branch information
guzman-raphael committed Sep 22, 2020
1 parent 82d7b3a commit 02960f1
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 2 deletions.
2 changes: 1 addition & 1 deletion +ghtb/require.m
Expand Up @@ -24,7 +24,7 @@ function require(requiredToolboxes, varargin)
% 'Version', '1.0.8'...
% )...
% };
% ghtb.require(requiredToolboxes)
% ghtb.require(requiredToolboxes) % require with prompts
% ghtb.require(requiredToolboxes, 'prompt', false)
p = inputParser;
addOptional(p, 'prompt', true);
Expand Down
Binary file modified GHToolbox.mltbx
Binary file not shown.
15 changes: 14 additions & 1 deletion README.md
Expand Up @@ -8,7 +8,7 @@

## Description

This Toolbox can be accessed via `ghtb` and provides a way to directly `install`, `uninstall`, or `package` MATLAB Community Toolboxes. For upgrade and downgrade use-cases, users can set the `override` option to force the install. `GHToolbox` makes the following assumptions:
This Toolbox can be accessed via `ghtb` and provides a way to directly `install`, `uninstall`, `require`, or `package` MATLAB Community Toolboxes. For upgrade and downgrade use-cases, users can set the `override` option to force the install. `GHToolbox` makes the following assumptions:

- Community Toolbox linked on FileExchange to GitHub via GitHub Releases.
- Community Toolbox publicly available as open-source on GitHub.
Expand All @@ -24,6 +24,19 @@ ghtb.install('guzman-raphael/compareVersions', 'version', '1.0.7') % default: ov
ghtb.install('guzman-raphael/compareVersions', 'version', '1.0.6', 'override', true)
ghtb.install('compareVersions.mltbx') %install from local toolbox file
ghtb.uninstall('compareVersions') % uninstalls all versions of Toolbox
requiredToolboxes = {...
struct(...
'Name', 'GHToolbox', ...
'ResolveTarget', 'datajoint/GHToolbox'...
), ...
struct(...
'Name', 'compareVersions', ...
'ResolveTarget', 'guzman-raphael/compareVersions', ...
'Version', '1.0.8'...
)...
};
ghtb.require(requiredToolboxes) % require with prompts
ghtb.require(requiredToolboxes, 'prompt', false)
ghtb.package('GHToolbox', ...
'Raphael Guzman', ...
'raphael.h.guzman@gmail.com', ...
Expand Down

0 comments on commit 02960f1

Please sign in to comment.