opencobra/MATLAB.devTools

Name: MATLAB.devTools

Owner: openCOBRA

Description: MATLAB Development Tools

Created: 2017-03-03 14:40:11.0

Updated: 2017-12-27 21:35:21.0

Pushed: 2018-01-15 10:53:46.0

Homepage: null

Size: 348

Language: Matlab

GitHub Committers

UserMost Recent Commit# Commits

Other Committers

UserEmailMost Recent Commit# Commits

README


| MATLAB R2016b | MATLAB R2015b | Code Coverage | Code Grade | |——–|——–|——–|——–| | Build Status | Build Status| codecov | Code grade

MATLAB.devTools - Contribute the smart way

Pre-requisites

Please follow the configuration instructions carefully. You may skip this if your system is already set up and you have git configured.

warning IMPORTANT: Please make sure that you have configured your SSH key in Github as explained here.

Installation

Download this repository (the folder ./MATLAB.devTools/ will be created). You can clone the repository using:

t clone git@github.com:opencobra/MATLAB.devTools.git MATLAB.devTools

warning Run this command in Terminal (on macOS and Linux) or in Git Bash (on Windows) - not in Matlab.

Do you want to contribute to The COBRA Toolbox?

Please follow the installation and contributing instructions.

asciicast

How do I use the MATLAB.devTools?

Making a contribution to any git repository from Matlab is straightforward. Type in Matlab within the MATLAB.devTools folder:

ontribute

You will then be presented by a menu:

1] Start a new feature (branch).
2] Select an existing feature (branch) to work on.
3] Publish a feature (branch).
4] Delete a feature (branch).
5] Update the fork.

lease select what you want to do (enter the number):

The original repository will be downloaded (cloned) the first time to a folder named fork-gitRepoName. Only files in the fork-gitRepoName folder will be considered for contribution (any changes made to a downloaded official git repository will be ignored).

warning If you get stuck or are faced with an system error message, please read the FAQ.

How can I update my fork without contributing?

In order to only update your fork, run >> contribute and select menu item [5].

Configure the MATLAB.devTools for another repository

warning The MATLAB.devTools can only be used with publicly accessible repositories.

If you want to use the MATLAB.devTools with a repository other than the default repository, you must set the following variables:

cher = '\n\n       ~~~ MATLAB.devTools ~~~\n\n'; % a message for the repository (any string)
teRepoURL = 'https://server.com/repositoryName.git'; % the remote url
Name = 'repoNickName'; % a nickName of the repository (any string)
ose = false;  % turn the verbose mode on (true) or off (false)

and run:

onfDevTools(launcher, remoteRepoURL, nickName, verbose);  % sets the configuration

In order to reset the configuration, type:

esetDevTools();

If you want your changes to be permanent, you can set the above mentioned variables in ./assets/confDevTools.m.


This work is supported by the National Institutes of Health's National Center for Advancing Translational Sciences, Grant Number U24TR002306. This work is solely the responsibility of the creators and does not necessarily represent the official views of the National Institutes of Health.