Skip to content

Commit

Permalink
Added documentation for compiling and installation
Browse files Browse the repository at this point in the history
Fixes to #1 with instructions for downloading, compiling and installation.
  • Loading branch information
savage13 authored Sep 13, 2021
1 parent b85817d commit 9cd687b
Showing 1 changed file with 35 additions and 0 deletions.
35 changes: 35 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,41 @@ sac_write(s, "output.sac", &nerr);
Downloading and installing
--------------------------
### Downloading
This library can be downloaded directly by either going to **Code->Download Zip** or by using git as:
git clone https://github.com/savage13/sacio.git
### Compiling
Once downloaded, the library can be compiled from within the `sacio` or `sacio-master` directory using:
./configure
make
### Installation
Installation to the default location `/usr/local` can be completed using:
make install
This will install `libsacio_bsd.a` into `/usr/local/lib/libsacio_bsd.a` and
`sacio.h` and `timespec.h` into the `/usr/local/inclucde/sacio` directory. Creating
a symbolic link to this library will assist in existing programs that require
the sacio library, e.g.:
ln -s /usr/local/lib/libsacio_bsd.a /usr/local/lib/libsacio.a
Passing the `--prefix` option to the configure command allows a different installation location.
### Testing
Tests for the library can be run if desired using
make test
Please report issues to the project.
If you would like to contribute to the project please file Pull Requests and/or create issues for discussion at the libsacio project.
Expand Down

0 comments on commit 9cd687b

Please sign in to comment.