Skip to content

Commit b022da4

Browse files
authored
doc: Add a single introduction page (#8515)
1 parent 760266d commit b022da4

File tree

5 files changed

+23
-54
lines changed

5 files changed

+23
-54
lines changed

doc/rst/source/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ it can do.
3737
:maxdepth: 1
3838
:caption: Getting started
3939

40+
intro
4041
install
4142
gallery
4243
animations

doc/rst/source/tutorial/bash/intro.rst renamed to doc/rst/source/intro.rst

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -35,15 +35,3 @@ maximize flexibility. We standardized early on to use PostScript output
3535
instead of other graphics formats. Apart from the built-in support for
3636
coastlines, GMT completely decouples data retrieval from the main
3737
GMT modules. GMT uses architecture-independent file formats.
38-
39-
GMT installation considerations
40-
-------------------------------
41-
42-
See the :doc:`install guide </install>`
43-
for instructions and to make sure you have all required dependencies installed.
44-
Alternatively, you can build GMT from source by following the
45-
`building guide <https://github.com/GenericMappingTools/gmt/blob/master/BUILDING.md>`_.
46-
47-
In addition, we recommend access to any flavor of the UNIX operating system
48-
(UNIX, Linux, macOS, Cygwin, MinGW, etc.).
49-
We do not recommend using the DOS command window under Windows.

doc/rst/source/tutorial/bash/index.rst

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,15 @@ sufficient detail. Nevertheless, it is hoped that the exposure
3333
will prompt the users to improve their GMT and UNIX skills
3434
after completion of this short tutorial.
3535

36+
See the :doc:`install guide </install>`
37+
for instructions and to make sure you have all required dependencies installed.
38+
Alternatively, you can build GMT from source by following the
39+
`building guide <https://github.com/GenericMappingTools/gmt/blob/master/BUILDING.md>`_.
40+
41+
In addition, we recommend access to any flavor of the UNIX operating system
42+
(UNIX, Linux, macOS, Cygwin, MinGW, etc.).
43+
We do not recommend using the DOS command window under Windows.
44+
3645
.. note::
3746
This tutorial is for GMT 6 modern mode only. Looking for the classic mode tutorial?
3847
Since classic mode commands haven't changed since GMT 5, please visit
@@ -41,7 +50,6 @@ after completion of this short tutorial.
4150
.. toctree::
4251
:maxdepth: 1
4352

44-
intro
4553
session-1
4654
session-2
4755
session-3

doc/rst/source/tutorial/julia/index.rst

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,10 +25,22 @@ still redirect to the hard-core GMT man pages, whilst others direct users to Jul
2525
the translated GMT manuals. A *lost case* is the GMT Technical Reference that is so big/complete that it
2626
will take long time to see a Julia version of it.
2727

28+
See the :doc:`install guide </install>`
29+
for instructions and to make sure you have all required dependencies installed.
30+
Alternatively, you can build GMT from source by following the
31+
`building guide <https://github.com/GenericMappingTools/gmt/blob/master/BUILDING.md>`_.
32+
33+
See also the general information about `Julia <https://julialang.org/learning/getting-started/>`_
34+
as well as the introduction to the Julia wrapper at
35+
`Introduction <https://www.generic-mapping-tools.org/GMTjl_doc/documentation/general/introduction/index.html#introduction>`_
36+
and the very recommendable
37+
`Quick Learn <https://www.generic-mapping-tools.org/GMTjl_doc/documentation/general/quick_learn/index.html#quick_learn/>`_.
38+
Complement with the instructions on how to
39+
install `GMT.jl <https://github.com/GenericMappingTools/GMT.jl#install>`_
40+
2841
.. toctree::
2942
:maxdepth: 1
3043

31-
intro
3244
session-1
3345
session-2
3446
session-3

doc/rst/source/tutorial/julia/intro.rst

Lines changed: 0 additions & 40 deletions
This file was deleted.

0 commit comments

Comments
 (0)