Skip to content

Commit

Permalink
adding requirements
Browse files Browse the repository at this point in the history
  • Loading branch information
laurentheirendt committed Apr 4, 2017
1 parent 3d39375 commit c94e921
Show file tree
Hide file tree
Showing 4 changed files with 54 additions and 10 deletions.
43 changes: 43 additions & 0 deletions .github/REQUIREMENTS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# Requirements

## Can I check if everything is properly set up before I start?

#### MATLAB

Please ensure that you have a working `MATLAB` [installation](https://nl.mathworks.com/help/install/).

#### git

You can check if you have a working installation of `git` by typing in the `Terminal` (on `linux` and `macOS`) or `Git Bash` (in `Windows`):
```bash
$ git --version
```
If installed properly, this will return `git version 2.10.1 [...]` or similar with another version number.

#### curl

You can check if you have a working installation of `curl` by typing in the terminal (or GUI Bash):
```bash
$ curl --version
```
which will return `curl 7.51.0 [...]` or similar with another version number if installed properly.

## What if my system is not properly configured?

**Linux (Ubuntu or Debian)**

```bash
$ sudo apt-get install git-all curl
```

**macOS**

In order to install `git`, install the [Xcode Command Line Tools](http://osxdaily.com/2014/02/12/install-command-line-tools-mac-os-x/). For `curl`, follow the instructions [here](http://macappstore.org/curl/).

**Windows**

Please download the `git` tools for Windows from [here](https://git-scm.com/download). During the installation process, please ensure that you select **Use Git from the Windows Command Prompt**. In addition, please make sure that you select **Checkout as-is, commit Unix-style line endings**.

<div align="center">
<img src="assets/installation_git_windows_0.png" height="280px">&nbsp;&nbsp;&nbsp;<img src="assets/installation_git_windows_1.png" height="280px">.
</div>
Binary file added .github/assets/installation_git_windows_0.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .github/assets/installation_git_windows_1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
21 changes: 11 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,28 +9,29 @@ The COBRA Toolbox <br> COnstraint-Based Reconstruction and Analysis Toolbox
|--------|--------|--------|--------|--------|--------|
| [![Build Status](https://prince.lcsb.uni.lu/jenkins/buildStatus/icon?job=COBRAToolbox-branches-auto/MATLAB_VER=R2016b)](https://prince.lcsb.uni.lu/jenkins/job/COBRAToolbox-branches-auto/MATLAB_VER=R2016b/) | [![Build Status](https://prince.lcsb.uni.lu/jenkins/buildStatus/icon?job=COBRAToolbox-branches-auto/MATLAB_VER=R2015b)](https://prince.lcsb.uni.lu/jenkins/job/COBRAToolbox-branches-auto/MATLAB_VER=R2015b/) | [![Build Status](https://prince.lcsb.uni.lu/jenkins/buildStatus/icon?job=COBRAToolbox-branches-auto/MATLAB_VER=R2014b)](https://prince.lcsb.uni.lu/jenkins/job/COBRAToolbox-branches-auto/MATLAB_VER=R2014b/) | [![codecov](https://codecov.io/gh/opencobra/cobratoolbox/branch/master/graph/badge.svg)](https://codecov.io/gh/opencobra/cobratoolbox/branch/master) | ![Code grade](https://prince.lcsb.uni.lu/jenkins/userContent/codegrade.svg "Ratio of the number of inefficient code lines and the total number of lines of code (in percent). A: 0-3%, B: 3-6%, C: 6-9%, D: 9-12%, E: 12-15%, F: > 15%.") | [![COBRAforum](https://img.shields.io/badge/COBRA-forum-blue.svg)](https://groups.google.com/forum/#!forum/cobra-toolbox) |

Pre-requisites
Requirements
--------------

Please follow [this guide](https://github.com/opencobra/MATLAB.devTools/blob/master/PREREQUISITES.md) in order to configure your system properly.
![#ff0000](https://placehold.it/15/ff0000/000000?text=+) Please follow [this guide](https://github.com/opencobra/cobratoolbox/blob/master/.github/REQUIREMENTS.md) in order to configure your system properly.

Installation
------------

1. Clone this repository (the folder `cobratoolbox` will be created). Do **not** download the repository as a `.zip` file.:
```sh
1. Download this repository (the folder `cobratoolbox` will be created). It is not recommended to download the repository as a `.zip` file. You can clone the repository using:
````bash
$ git clone https://github.com/opencobra/cobratoolbox.git cobratoolbox
```
````
![#ff0000](https://placehold.it/15/ff0000/000000?text=+) This command must be run in the `Terminal` (on `linux` and `macOS`) or your `Git Bash` (on `Windows`), and **not** in `MATLAB`.

2. Change to the folder `cobratoolbox` and from `MATLAB`, run
```Matlab
````Matlab
>> initCobraToolbox
```
````

3. You can test your installation by running:
```Matlab
3. You can test your installation by running from `MATLAB`:
````Matlab
>> testAll
```
````

Tutorials
---------
Expand Down

0 comments on commit c94e921

Please sign in to comment.