From b056c678af8af26cd2a83a5d1fe377c986cdc53c Mon Sep 17 00:00:00 2001 From: Leonardo Uieda Date: Sun, 12 Aug 2018 17:34:40 -1000 Subject: [PATCH] Convert the README to markdown Nothing too fancy. Made a few minor style changes and moved the citation request to the top. Add the Travis badge as well. --- README => README.md | 95 ++++++++++++++++++--------------------------- 1 file changed, 38 insertions(+), 57 deletions(-) rename README => README.md (87%) diff --git a/README b/README.md similarity index 87% rename from README rename to README.md index 11ae78e8625..a03795c665b 100644 --- a/README +++ b/README.md @@ -1,6 +1,8 @@ -$Id$ +# Generic Mapping Tools -== Information for installing GMT 6 == +[![TravisCI](http://img.shields.io/travis/GenericMappingTools/gmt/master.svg?style=flat-square&label=TravisCI)](https://travis-ci.org/GenericMappingTools/gmt) + +## Information for installing GMT 6 Note: The build system has recently been switched to CMake which is a cross-platform system for managing the build process. If you are familiar @@ -8,8 +10,7 @@ with the old GNU Build Tools (automake, autoconf, and configure) you can probably skip over to the CMake quick start guide in README.CMake. -Introduction ------------- +## Introduction You do not need to read these instructions unless you plan to build and install the programs manually. @@ -33,15 +34,21 @@ For Windows users there are separate Windows installers available; this discussion only considers UNIX/Linux/OS X installations. Windows users who which to build GMT from the sources refer to README.WIN32. +## A reminder + +If you think it is appropriate, you may consider paying us back by including +our latest EOS article (Wessel, P., W. H. F. Smith, R. Scharroo, J. F. Luis, +and F. Wobbe (2013), Generic Mapping Tools: Improved version released, Eos +Trans. AGU, 94(45), 409-410, doi:10.1002/2013EO450001) in the reference list +of your future publications that will benefit from the availability of GMT. -CMake ------ + +## CMake Install CMake (>=2.8.5) from http://www.cmake.org/cmake/resources/software.html -Install netCDF library ----------------------- +## Install netCDF library For all major Linux distributions there are prepackaged development binaries available. netCDF is also available on MacOSX trough the macports and fink @@ -51,15 +58,13 @@ Otherwise, get netCDF from http://www.unidata.ucar.edu/downloads/netcdf/. You need at least version 4.0 with netCDF-4/HDF5 data model support (do not disable HDF5/ZLIB in netCDF with --disable-netcdf-4). -Install CURL library --------------------- +## Install CURL library To handle URLs we depend on libcurl so install via your favorite package manager if it is not intrinsic to your Unix installation. Otherwise, get it from https://curl.haxx.se. -GDAL (optional) ---------------- +## GDAL (optional) To use the GDAL interface (ability to provide grids or images to be imported via gdal) you must have the GDAL library and include files installed. Like @@ -67,8 +72,7 @@ netCDF, GDAL is available through your favorite package manager on many *NIX systems. -PCRE (optional) ---------------- +## PCRE (optional) To use the PCRE interface (ability to specify regular expressions in some search options, e.g., gmtconvert) you must have the PCRE library and include @@ -79,10 +83,9 @@ Because GDAL already links with PCRE1 it is most practical to use that version. But if you insist, GMT can also be compiled with PCRE2. -LAPACK (optional) ---------------- +## LAPACK (optional) -To greatly speed up some linear algebra calculations (greenspline in +To greatly speed up some linear algebra calculations (greenspline in particular) you must have the LAPACK library and include files installed. LAPACK is available through your favorite package manager on many *NIX systems or in the case of OS X is built in. Normally this also installs @@ -90,23 +93,21 @@ BLAS but if not you need to do that separately as we are using some cblas_* functions to do linear algebra calculations. -Install support data --------------------- +## Install support data You can obtain GMT from http://gmt.soest.hawaii.edu/. Alternatively you may get GMT from any of the following FTP sites. Try the site that is closest to you to minimize transmission times: -Site FTP address --------------------------------------------------------------- -SOEST, U. of Hawaii ftp.soest.hawaii.edu -Lab for Satellite Altimetry, NOAA ibis.grdl.noaa.gov -IRIS, Washington, US ftp.iris.washington.edu -IAG-USP, U. of Sao Paulo, BRAZIL ftp.iag.usp.br -ISV, Hokkaido U, Sapporo, JAPAN ftp.eos.hokudai.ac.jp -GDS, Vienna U. of Technology, AUSTRIA gd.tuwien.ac.at -TENET, Tertiary Education & Research Networks, SOUTH AFRICA - gmt.mirror.ac.za +| Site | FTP address | +|:------------------------------------------------------------|:------------------------| +| SOEST, U. of Hawaii | ftp.soest.hawaii.edu | +| Lab for Satellite Altimetry, NOAA | ibis.grdl.noaa.gov | +| IRIS, Washington, US | ftp.iris.washington.edu | +| IAG-USP, U. of Sao Paulo, BRAZIL | ftp.iag.usp.br | +| ISV, Hokkaido U, Sapporo, JAPAN | ftp.eos.hokudai.ac.jp | +| GDS, Vienna U. of Technology, AUSTRIA | gd.tuwien.ac.at | +| TENET, Tertiary Education & Research Networks, SOUTH AFRICA | gmt.mirror.ac.za | The development sources are available from the subversion repository at svn://gmtserver.soest.hawaii.edu/gmt/trunk @@ -115,8 +116,7 @@ Extract the files and put them in a separate directory (need not be where you eventually want to install GMT). -Configuring ------------ +## Configuring GMT can be build on any platform supported by CMake. CMake is a cross-platform, open-source system for managing the build process. @@ -165,8 +165,7 @@ it will give you a message and you will be asked to edit cmake/ConfigUser.cmake. -Build GMT ---------- +## Build GMT In the build directory, type @@ -185,8 +184,7 @@ executables removed by saying or just remove the entire build directory. -Documentation -_____________ +## Documentation The documentation is available online at http://gmt.soest.hawaii.edu/ or as platform independent package that you can install along with GMT. @@ -203,16 +201,14 @@ documentation. The manuals, HTML pages, and PDFs have to be created from source with Sphinx (see README.CMake). -Set path --------- +## Set path Make sure users set their PATH to include the directory containing the GMT executables (BINDIR) if this is not a standard directory like /usr/local/bin. You should now be able to run GMT programs. -GMT supplemental Code ---------------------- +## GMT supplemental Code GMT users elsewhere have developed programs that utilize the GMT libraries and produce PostScript code compatible with the rest of GMT or simply perform data @@ -231,8 +227,7 @@ libraries. Currently, the supplemental archive include the directories: x2sys - Track intersection (crossover) tools. -Misc ----- +## Misc Before running programs, there are a few things you should do/know: @@ -244,18 +239,7 @@ Before running programs, there are a few things you should do/know: the associated man page. -A reminder ----------- - -If you think it is appropriate, you may consider paying us back by including -our latest EOS article (Wessel, P., W. H. F. Smith, R. Scharroo, J. F. Luis, -and F. Wobbe (2013), Generic Mapping Tools: Improved version released, Eos -Trans. AGU, 94(45), 409-410, doi:10.1002/2013EO450001) in the reference list -of your future publications that will benefit from the availability of GMT. - - -Software support ----------------- +## Software support You haven't bought anything so you cannot expect full service. However, if you find a bug in any of the programs, please report it to us @@ -268,8 +252,7 @@ can also post general questions on the GMT user forum. Note that registration is required to post on the site. -Ordering the GMT package on CD/DVD-Rs -------------------------------------- +## Ordering the GMT package on CD/DVD-Rs Should you or someone you know without net-access need to obtain GMT: Geoware makes and distributes CD/DVD-Rs with the GMT package and many @@ -280,5 +263,3 @@ sets (up to 60 Gb of data!) visit http://www.geoware-online.com/. Good luck! The GMT Team. - -vim: tw=78 et ts=2 sts=2 sw=2 autoindent smartindent