installation.md 1.7 KB
Newer Older
Laurent Heirendt's avatar
Laurent Heirendt committed
1
2
3
4
## Installation

<img src="img/github_app.png" class="as-is" height="300" />

5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
**Linux (Ubuntu)**

```sh
sudo apt-get install git-all
```
<br>
**macOS**

Install *Xcode Command Line Tools*

<br>
**Windows**

Follow instructions on *[git-for-windows.github.io](https://git-for-windows.github.io)*.

**or:** `MobaXTerm` with `git` plugin: *[mobaxterm.mobatek.net](https://mobaxterm.mobatek.net)*.

<small>More on *[git-scm.com/book/en/v2/Getting-Started-Installing-Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)*</small>


## How to start?

**Linux (Ubuntu)** and **macOS**

Laurent Heirendt's avatar
Laurent Heirendt committed
29
30
Start the terminal (or any other shell)

31
32
33
<br>
**Windows**

Laurent Heirendt's avatar
Laurent Heirendt committed
34
Start `GUI Bash` or `MobaXTerm`.
Laurent Heirendt's avatar
Laurent Heirendt committed
35

36

Laurent Heirendt's avatar
Laurent Heirendt committed
37
## How to configure `git`?
Laurent Heirendt's avatar
Laurent Heirendt committed
38
39
40
41
42
43
44
45
46
47
48

```shell
$ git config --global user.name "Firstname Lastname"
$ git config --global user.email "first.last@uni.lu"
```


## Does it work?

```shell
$ git --version
Laurent Heirendt's avatar
Laurent Heirendt committed
49
# git version 2.10.0
Laurent Heirendt's avatar
Laurent Heirendt committed
50
```
Laurent Heirendt's avatar
Laurent Heirendt committed
51
52
53
54
55
56
57
58
59
60
61
62
63
64


## Test the configuration

Test whether your username and email have been registered

```sh
$ git config -l
```

<br>
This should list the configuration with `user.name` and `user.email`.


Laurent Heirendt's avatar
Laurent Heirendt committed
65
66
67
## I need to get
<br>
##`The COBRAToolbox` - How?
Laurent Heirendt's avatar
Laurent Heirendt committed
68
69
70
71
72
73
74
75
76
77
78

Simply `clone` the repository (i.e., retrieve a copy)
```sh
$ git clone https://github.com/opencobra/cobratoolbox.git cobratoolbox
```

Any other rudimentary method such as

*'I simply download the `.zip` un unzip it - works like a charm!'*

shall **be avoided**!
Laurent Heirendt's avatar
Laurent Heirendt committed
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93


## How do I get any other repository?

You can clone any other repository with:
```sh
$ git clone https://github.com/userName/myRepo.git myRepo
```

<br>
Clone the training repository with:
```sh
$ git clone https://git-r3lab.uni.lu/git-training/practice.git practice
```
Note: You may be prompted to enter your credentials.