Skip to content

Commit bd2df7b

Browse files
committed
Update readme
Mention command to enable git hooks Add some extra whitespace
1 parent 7378494 commit bd2df7b

File tree

1 file changed

+15
-2
lines changed

1 file changed

+15
-2
lines changed

README.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,13 @@ multio is a package developed by ECMWF that provides an application programming
1212
The fundamental design principle behind multio is that data is decoupled from metadata, and that the
1313
metadata is used for routing the data through the post-processing pipelines.
1414

15+
1516
Documentation
16-
------------
17+
-------------
1718

1819
The documentation can be found at https://multio.readthedocs.io.
1920

21+
2022
Requirements
2123
------------
2224

@@ -37,6 +39,7 @@ Build dependencies:
3739
- ecbuild -- ECMWF library of CMake macros (available via apt or see https://github.com/ecmwf/ecbuild)
3840
- MPI -- an implementation of MPI may be required for the I/O-server functionality, see https://www.mpi-forum.org/
3941

42+
4043
Installation
4144
------------
4245

@@ -72,8 +75,18 @@ Now proceed with installation as follows.
7275
make install
7376
```
7477

78+
79+
GIT hooks
80+
---------
81+
82+
Please run the following command in the project root to use our git hooks:
83+
```bash
84+
git config core.hooksPath .githooks
85+
```
86+
87+
7588
Copyright and license
76-
------------
89+
---------------------
7790

7891
(C) Copyright 2005- ECMWF.
7992

0 commit comments

Comments
 (0)