Skip to content

Commit

Permalink
Add gentoo to INSTALL.md and WSL to non-unix-platforms.rst (#5269)
Browse files Browse the repository at this point in the history
* INSTALL.md: add gentoo

* Update INSTALL.md

Co-authored-by: Meghan Jones <[email protected]>

* INSTALL.md: fix typo

* non-unix-platforms.rst: add section on WSL

* Update doc/rst/source/cookbook/non-unix-platforms.rst

Co-authored-by: Meghan Jones <[email protected]>

* Update doc/rst/source/cookbook/non-unix-platforms.rst

Co-authored-by: Meghan Jones <[email protected]>

* Update doc/rst/source/cookbook/non-unix-platforms.rst

Co-authored-by: Meghan Jones <[email protected]>

Co-authored-by: Paul Wessel <[email protected]>
Co-authored-by: Meghan Jones <[email protected]>
  • Loading branch information
3 people committed Jun 17, 2021
1 parent 5ddd715 commit f42bb61
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 1 deletion.
11 changes: 10 additions & 1 deletion INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ for compiling GMT source package (either stable release or development version).
* [RHEL/CentOS](#rhelcentos)
* [Ubuntu/Debian](#ubuntudebian)
* [ArchLinux](#archlinux)
* [Gentoo](#gentoo)
- [Cross Platform Install Instructions](#cross-platform-install-instructions)
* [Install via conda](#install-via-conda)
- [FreeBSD](#freebsd)
Expand All @@ -42,7 +43,7 @@ animated GIFs.

**NOTE:**
There are several options for using [GMT on non-UNIX systems](https://docs.generic-mapping-tools.org/latest/cookbook/non-unix-platforms.html)
such as Windows, including [Windows Subsytem for Linux](https://docs.microsoft.com/en-us/windows/wsl/),
such as Windows, including [Windows Subsystem for Linux](https://docs.microsoft.com/en-us/windows/wsl/),
MinGW/MSYS2, Cygwin, or DOS batch scripts. The last option will not provide you
with any UNIX tools so you will be limited to what you can do with DOS batch files.
One simple option for accessing a UNIX style bash terminal is *Git for Windows*,
Expand Down Expand Up @@ -197,6 +198,14 @@ Install other GMT dependencies (some are optional) via:
ArchLinux official repository doesn't provide GMT packages, but AUR (ArchLinux User Repository) does.
You can follow the [Install latest GMT on ArchLinux](https://github.com/GenericMappingTools/gmt/wiki/Install-latest-GMT-on-ArchLinux) in the wiki.

### Gentoo

**NOTE:** This may provide old GMT versions. Consider [building from source](BUILDING.md).

Install GMT via:

sudo emerge gmt

## Cross Platform Install Instructions

### Install via conda
Expand Down
18 changes: 18 additions & 0 deletions doc/rst/source/cookbook/non-unix-platforms.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ solutions:
WINDOWS:
Choose among these three possibilities:

#. Windows Subsystem for Linux

#. Install GMT under MinGW/MSYS2 (A collection of GNU utilities).

#. Install GMT under Cygwin (A GNU port to Windows).
Expand All @@ -25,6 +27,22 @@ WINDOWS:
with DOS batch files.


Windows Subsystem for Linux
---------------------------
If you're running Windows 10 you may take advantage of the Windows Subsystem for Linux.
This provides an easy way of setting up a functional Linux environment and required tools to build and use GMT.

From the Windows Subsystem for Linux Documentation:

The Windows Subsystem for Linux lets developers run a GNU/Linux environment
-- including most command-line tools, utilities, and applications
-- directly on Windows, unmodified, without the overhead of a traditional virtual machine or dual-boot setup.

See `Windows Subsystem for Linux Documentation <https://docs.microsoft.com/en-us/windows/wsl/>`_ to get started.

Once WSL is installed, choose a distribution (e.g. Debian) and follow the `install <https://github.com/GenericMappingTools/gmt/blob/master/INSTALL.md#ubuntudebian>`_
instructions or `build from source <https://github.com/GenericMappingTools/gmt/blob/master/BUILDING.md>`_.

MINGW|MSYS2 and GMT
-------------------

Expand Down

0 comments on commit f42bb61

Please sign in to comment.