3.1.1 : Le readme.md

On commence par un logo : 
1

![PLIBS_9 logo](doc/logo.png)


Ensuite, les badges qui définissent si la CI du projet se porte bien (status du pipeline et couverture des tests unitaires) : 
1
2
3

---- 
[![pipeline status](https://gitlab.in2p3.fr/CTA-LAPP/PHOENIX_LIBS/TESTS/TestProjectReleaseOnTag/badges/master/pipeline.svg)](https://gitlab.in2p3.fr/CTA-LAPP/PHOENIX_LIBS/TESTS/TestProjectReleaseOnTag/-/commits/master)
[![coverage report](https://gitlab.in2p3.fr/CTA-LAPP/PHOENIX_LIBS/TESTS/TestProjectReleaseOnTag/badges/master/coverage.svg)](https://gitlab.in2p3.fr/CTA-LAPP/PHOENIX_LIBS/TESTS/TestProjectReleaseOnTag/-/commits/master)


Où trouver le programme : 
1
2
3

# Code

https://gitlab.in2p3.fr/CTA-LAPP/PHOENIX_LIBS/TESTS/TestProjectReleaseOnTag


Lien vers la documentation : 
1
2
3

# Documentation

https://cta-lapp.pages.in2p3.fr/PHOENIX_LIBS/TESTS/TestProjectReleaseOnTag/


Dépendences du projet (surtout pour la compilation) : 
1
2
3
4
5

# Requirements

- c++ compiler (tested with g++ 5,6,7,8,9,10 and clang 9,10)
- cmake > 3
- make


Comment installer le projet : 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37

# Installation for Users

```sh
	$ git clone https://gitlab.in2p3.fr/CTA-LAPP/PHOENIX_LIBS/TESTS/TestProjectReleaseOnTag.git
	$ cd TestProjectReleaseOnTag
	$ ./install.sh
```

Then **TestProjectReleaseOnTag** is installed in your $HOME/usr.


If you prefer a customized install path you can do :

```sh
	$ git clone https://gitlab.in2p3.fr/CTA-LAPP/PHOENIX_LIBS/TESTS/TestProjectReleaseOnTag.git
	$ cd TestProjectReleaseOnTag
	$ ./install.sh /your/install/path
```

If you prefer a customized install path with custom compilation you can do :

```sh
	$ git clone https://gitlab.in2p3.fr/CTA-LAPP/PHOENIX_LIBS/TESTS/TestProjectReleaseOnTag.git
	$ cd TestProjectReleaseOnTag
	$ mkdir -p build
	$ cd build
	$ cmake .. -DCMAKE_INSTALL_PREFIX=/your/install/Path
	$ make -j `nproc`
	$ make install -j `nproc`
```

The **nproc** gives the number of cores of the computer. If you want a build on one core you can just type :

```sh
	$ make
	$ make install
```


Comment mettre à jour le projet : 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

# Update TestProjectReleaseOnTag

If you want to update the software :

```sh
	$ git clone https://gitlab.in2p3.fr/CTA-LAPP/PHOENIX_LIBS/TESTS/TestProjectReleaseOnTag.git
	$ cd TestProjectReleaseOnTag
	$ ./update.sh
```

If you want to update the software with a custom install path :

```sh
	$ git clone https://gitlab.in2p3.fr/CTA-LAPP/PHOENIX_LIBS/TESTS/TestProjectReleaseOnTag.git
	$ cd TestProjectReleaseOnTag
	$ ./update.sh /your/install/path
```


Le fichier README.md complet : 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71

<!--Dummy comment  -->
![PLIBS_9 logo](doc/logo.png)
---- 
[![pipeline status](https://gitlab.in2p3.fr/CTA-LAPP/PHOENIX_LIBS/TESTS/TestProjectReleaseOnTag/badges/master/pipeline.svg)](https://gitlab.in2p3.fr/CTA-LAPP/PHOENIX_LIBS/TESTS/TestProjectReleaseOnTag/-/commits/master)
[![coverage report](https://gitlab.in2p3.fr/CTA-LAPP/PHOENIX_LIBS/TESTS/TestProjectReleaseOnTag/badges/master/coverage.svg)](https://gitlab.in2p3.fr/CTA-LAPP/PHOENIX_LIBS/TESTS/TestProjectReleaseOnTag/-/commits/master)
# Code

https://gitlab.in2p3.fr/CTA-LAPP/PHOENIX_LIBS/TESTS/TestProjectReleaseOnTag
# Documentation

https://cta-lapp.pages.in2p3.fr/PHOENIX_LIBS/TESTS/TestProjectReleaseOnTag/
# Requirements

- c++ compiler (tested with g++ 5,6,7,8,9,10 and clang 9,10)
- cmake > 3
- make
# Installation for Users

```sh
	$ git clone https://gitlab.in2p3.fr/CTA-LAPP/PHOENIX_LIBS/TESTS/TestProjectReleaseOnTag.git
	$ cd TestProjectReleaseOnTag
	$ ./install.sh
```

Then **TestProjectReleaseOnTag** is installed in your $HOME/usr.


If you prefer a customized install path you can do :

```sh
	$ git clone https://gitlab.in2p3.fr/CTA-LAPP/PHOENIX_LIBS/TESTS/TestProjectReleaseOnTag.git
	$ cd TestProjectReleaseOnTag
	$ ./install.sh /your/install/path
```

If you prefer a customized install path with custom compilation you can do :

```sh
	$ git clone https://gitlab.in2p3.fr/CTA-LAPP/PHOENIX_LIBS/TESTS/TestProjectReleaseOnTag.git
	$ cd TestProjectReleaseOnTag
	$ mkdir -p build
	$ cd build
	$ cmake .. -DCMAKE_INSTALL_PREFIX=/your/install/Path
	$ make -j `nproc`
	$ make install -j `nproc`
```

The **nproc** gives the number of cores of the computer. If you want a build on one core you can just type :

```sh
	$ make
	$ make install
```

# Update TestProjectReleaseOnTag

If you want to update the software :

```sh
	$ git clone https://gitlab.in2p3.fr/CTA-LAPP/PHOENIX_LIBS/TESTS/TestProjectReleaseOnTag.git
	$ cd TestProjectReleaseOnTag
	$ ./update.sh
```

If you want to update the software with a custom install path :

```sh
	$ git clone https://gitlab.in2p3.fr/CTA-LAPP/PHOENIX_LIBS/TESTS/TestProjectReleaseOnTag.git
	$ cd TestProjectReleaseOnTag
	$ ./update.sh /your/install/path
```


Lien de téléchargement ici.