diff --git a/README.md b/README.md index 1a249ab..15a4aab 100644 --- a/README.md +++ b/README.md @@ -2,36 +2,59 @@ TREX library fo efficient I/O. -## Current installation procedure from the tarball (`trexio-.tar.gz`): -1. `gzip -cd trexio-.tar.gz | tar xvf -` -2. `cd trexio-` -3. `./configure` -4. `make && sudo make install` -5. `make check` +## Minimal requirements (for users): -## Current (temporary) installation procedure from the GitHub repo clone: +- Autoconf +- C compiler (gcc/icc/clang) +- Fortran compiler (gfortran/ifort/flang) + + +## Installation procedure from the tarball (for users): + +1. Download the `trexio-.tar.gz` file +2. `gzip -cd trexio-.tar.gz | tar xvf -` +3. `cd trexio-` +4. `./configure` +5. `make && sudo make install` +6. `make check` + + +**Note: on systems with no `sudo` rights access, one can replace `./configure` with `./configure prefix=${PWD}` in order to execite `make install/uninstall` commands without `sudo`. This will enable the installation in the root directory of the library.** + + +## Additional requirements (for developers): + +- Automake +- python3 (>=3.6) +- emacs (>=26.0) + + +## Installation procedure from the GitHub repo clone (for developers): 1. `git clone https://github.com/TREX-CoE/trexio.git` 2. `cd trexio` -4. `cd tools && ./build_trexio.sh && cd ..` -5. `autoreconf` -6. `automake --add-missing --copy` -7. `./configure` -8. `make && sudo make install` -9. `make check` +3. `cd tools && ./build_trexio.sh && cd ..` +4. `autoreconf` +5. `automake --add-missing --copy` +6. `./configure` +7. `make && sudo make install` +8. `make check` -**Note: on systems with no `sudo` access, one can replace `./configure` with `./configure prefix=${PWD}` in order to execite `make install/uninstall` commands with `sudo` rights. This will enable the installation in the root directory of the library.** ## Tutorial **TODO** + ## Technical 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 Note: The code should be compliant with the C99 [CERT C coding standard](https://resources.sei.cmu.edu/downloads/secure-coding/assets/sei-cert-c-coding-standard-2016-v01.pdf). This can be checked with the `cppcheck` tool. + +