Skip to content

Commit

Permalink
Update README.md with basic intro and bumped HDF5 version
Browse files Browse the repository at this point in the history
  • Loading branch information
drsteve committed May 17, 2024
1 parent 9ce25ce commit 620dcd5
Showing 1 changed file with 25 additions and 14 deletions.
39 changes: 25 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,49 @@
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.1133781.svg)](https://doi.org/10.5281/zenodo.1133781)
[![Build Status](https://github.com/drsteve/LANLGeoMag/actions/workflows/lgm-ci.yml/badge.svg)](https://github.com/drsteve/LANLGeoMag/actions/workflows/lgm-ci.yml)


Build instructions for Linux are in INSTALL, which is generated by automake.
Also see ./configure --help for some useful options. Additional information
can be found in the HACKING file, including hints for Mac users and
instructions for recent HDF5 library updates. Guidance for contributors can
be found in WORKFLOW.md.
Getting Started with LANLGeoMag
===============================
Clone or download from https://github.com/drsteve/LANLGeoMag

If everything is set up correctly:
```
autoreconf -i
./configure
make -j
make install
```

Also see `./configure --help` for options at configure time, and
additional helpful information can be found in the `HACKING` file.
Autogenerated instructions for Linux are given in `INSTALL`, which
is generated by automake when `autoreconf -i` is run.
Guidance for contributors can be found in WORKFLOW.md.

Dependencies are:

perl
====
LanlGeoMag links against libperl, so you need perl development headers.
----
OPTIONAL: LanlGeoMag optionally links against libperl, so you may need perl development headers.
Ubuntu package: libperl-dev

GNU Scientific Library
======================
----------------------
Again, the development package is required.
Ubuntu packge: libgsl0-dev

HDF5 1.8
========
Must be version 1.8 or later. Development package required.
HDF5 1.10
---------
Must be version 1.10 or later. Development package required.
Ubuntu package: any package that provides libhdf5-dev. libhdf5-serial-dev is suggested.

GNU Autoconf, Automake and Libtool
==================================
----------------------------------
LanlGeoMag uses GNU autotools to build the configure scripts and makefiles.
On GNU systems these are provided with the operating system. On Mac these were
provided with XCode prior to version 4.3 (Shipped with OS X).
Mac install: (MacPorts) sudo port --verbose install autoconf automake libtool

GNU argp
========
--------
On non-GNU systems argp must be installed prior to building LanlGeoMag.
Mac package: argp-standalone (known to be provided by MacPorts and HomeBrew)

0 comments on commit 620dcd5

Please sign in to comment.