Skip to content

Commit

Permalink
doc: Add a single introduction page (#8515)
Browse files Browse the repository at this point in the history
  • Loading branch information
seisman committed Jun 6, 2024
1 parent 760266d commit b022da4
Show file tree
Hide file tree
Showing 5 changed files with 23 additions and 54 deletions.
1 change: 1 addition & 0 deletions doc/rst/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ it can do.
:maxdepth: 1
:caption: Getting started

intro
install
gallery
animations
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,15 +35,3 @@ maximize flexibility. We standardized early on to use PostScript output
instead of other graphics formats. Apart from the built-in support for
coastlines, GMT completely decouples data retrieval from the main
GMT modules. GMT uses architecture-independent file formats.

GMT installation considerations
-------------------------------

See the :doc:`install guide </install>`
for instructions and to make sure you have all required dependencies installed.
Alternatively, you can build GMT from source by following the
`building guide <https://github.com/GenericMappingTools/gmt/blob/master/BUILDING.md>`_.

In addition, we recommend access to any flavor of the UNIX operating system
(UNIX, Linux, macOS, Cygwin, MinGW, etc.).
We do not recommend using the DOS command window under Windows.
10 changes: 9 additions & 1 deletion doc/rst/source/tutorial/bash/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,15 @@ sufficient detail. Nevertheless, it is hoped that the exposure
will prompt the users to improve their GMT and UNIX skills
after completion of this short tutorial.

See the :doc:`install guide </install>`
for instructions and to make sure you have all required dependencies installed.
Alternatively, you can build GMT from source by following the
`building guide <https://github.com/GenericMappingTools/gmt/blob/master/BUILDING.md>`_.

In addition, we recommend access to any flavor of the UNIX operating system
(UNIX, Linux, macOS, Cygwin, MinGW, etc.).
We do not recommend using the DOS command window under Windows.

.. note::
This tutorial is for GMT 6 modern mode only. Looking for the classic mode tutorial?
Since classic mode commands haven't changed since GMT 5, please visit
Expand All @@ -41,7 +50,6 @@ after completion of this short tutorial.
.. toctree::
:maxdepth: 1

intro
session-1
session-2
session-3
Expand Down
14 changes: 13 additions & 1 deletion doc/rst/source/tutorial/julia/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,22 @@ still redirect to the hard-core GMT man pages, whilst others direct users to Jul
the translated GMT manuals. A *lost case* is the GMT Technical Reference that is so big/complete that it
will take long time to see a Julia version of it.

See the :doc:`install guide </install>`
for instructions and to make sure you have all required dependencies installed.
Alternatively, you can build GMT from source by following the
`building guide <https://github.com/GenericMappingTools/gmt/blob/master/BUILDING.md>`_.

See also the general information about `Julia <https://julialang.org/learning/getting-started/>`_
as well as the introduction to the Julia wrapper at
`Introduction <https://www.generic-mapping-tools.org/GMTjl_doc/documentation/general/introduction/index.html#introduction>`_
and the very recommendable
`Quick Learn <https://www.generic-mapping-tools.org/GMTjl_doc/documentation/general/quick_learn/index.html#quick_learn/>`_.
Complement with the instructions on how to
install `GMT.jl <https://github.com/GenericMappingTools/GMT.jl#install>`_

.. toctree::
:maxdepth: 1

intro
session-1
session-2
session-3
Expand Down
40 changes: 0 additions & 40 deletions doc/rst/source/tutorial/julia/intro.rst

This file was deleted.

0 comments on commit b022da4

Please sign in to comment.