TREX/trexio
1
0
Fork 0
mirror of https://github.com/TREX-CoE/trexio.git synced 2024-11-03 20:54:07 +01:00
Code Issues Projects Releases Wiki Activity

enhance README

Browse Source
This commit is contained in:
q-posev 2021-06-25 11:51:06 +02:00
parent 3a4e737630
commit 81755ed821
1 changed files with 7 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -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 # 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. TREX library fo efficient I/O.
@ -19,13 +20,13 @@ TREX library fo efficient I/O.
1. Download the `trexio-<version>.tar.gz` file 1. Download the `trexio-<version>.tar.gz` file
2. `gzip -cd trexio-<version>.tar.gz | tar xvf -` 2. `gzip -cd trexio-<version>.tar.gz | tar xvf -`
3. `cd trexio-<version>` 3. `cd trexio-<version>`
4. `./configure` 4. `./configure --enable-silent-rules`
5. `make` 5. `make`
6. `make check` 6. `make check`
7. `sudo make install` 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): ## Additional requirements (for developers):
@ -39,7 +40,7 @@ TREX library fo efficient I/O.
1. `git clone https://github.com/TREX-CoE/trexio.git` 1. `git clone https://github.com/TREX-CoE/trexio.git`
2. `cd trexio` 2. `cd trexio`
3. `./autogen.sh` 3. `./autogen.sh`
4. `TREXIO_DEVEL=1 ./configure` 4. `TREXIO_DEVEL=1 ./configure --enable-maintainer-mode`
5. `make` 5. `make`
6. `make check` 6. `make check`
7. `sudo make install` 7. `sudo make install`
@ -52,7 +53,7 @@ TREX library fo efficient I/O.
## Technical documentation ## 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 ### Miscellaneous