From 81755ed8213193e5666d86d8442cd09014a53452 Mon Sep 17 00:00:00 2001 From: q-posev Date: Fri, 25 Jun 2021 11:51:06 +0200 Subject: [PATCH] enhance README --- README.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 6e5f627..8101873 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,9 @@ -[![build](https://github.com/TREX-CoE/trexio/actions/workflows/actions.yml/badge.svg)](https://github.com/TREX-CoE/trexio/actions/workflows/actions.yml) -![GitHub release (latest by date)](https://img.shields.io/github/v/release/TREX-CoE/trexio) # TREXIO +[![build](https://github.com/TREX-CoE/trexio/actions/workflows/actions.yml/badge.svg)](https://github.com/TREX-CoE/trexio/actions/workflows/actions.yml) +![GitHub release (latest by date)](https://img.shields.io/github/v/release/TREX-CoE/trexio) + TREX library fo efficient I/O. @@ -19,13 +20,13 @@ TREX library fo efficient I/O. 1. Download the `trexio-.tar.gz` file 2. `gzip -cd trexio-.tar.gz | tar xvf -` 3. `cd trexio-` -4. `./configure` +4. `./configure --enable-silent-rules` 5. `make` 6. `make check` 7. `sudo make install` -**Note: on systems with no `sudo` rights access, one can replace `./configure` with `./configure prefix=${PWD}` in order to execute `make install/uninstall` commands without `sudo`. This will enable the installation in the root directory of the library.** +**Note: on systems with no `sudo` access, one can replace `./configure` with `./configure prefix=${PWD}/_install` in order to execute `make install/uninstall` commands without `sudo` privileges.** ## Additional requirements (for developers): @@ -39,7 +40,7 @@ TREX library fo efficient I/O. 1. `git clone https://github.com/TREX-CoE/trexio.git` 2. `cd trexio` 3. `./autogen.sh` -4. `TREXIO_DEVEL=1 ./configure` +4. `TREXIO_DEVEL=1 ./configure --enable-maintainer-mode` 5. `make` 6. `make check` 7. `sudo make install` @@ -52,7 +53,7 @@ TREX library fo efficient I/O. ## Technical documentation -[Documentation generated from TREXIO org-mode files](https://trex-coe.github.io/trexio/) +[Documentation generated from TREXIO org-mode files.](https://trex-coe.github.io/trexio/) ### Miscellaneous