Skip to content

Minor formatting on the markdown styling #423

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 23, 2019
Merged

Minor formatting on the markdown styling #423

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 13 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Source code is included in the geos-3.3.3 directory.

* On linux, if your python was installed via a package management system, make
sure the corresponding "python-dev" package is also installed. Otherwise, you
may not have the python header (Python.h), which is required to build python
may not have the python header (`Python.h`), which is required to build python
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is reStructuredText not Markdown. Please use double backticks for literal quotes.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The file is .md; single backticks are correct.

C extensions.

### Optional
Expand All @@ -34,15 +34,15 @@ PIL should work on Python 2.x. Pillow is a maintained fork of PIL.

## Copyright

source code for the GEOS library is
included in the 'geos-3.3.3' directory under the terms given in
Source code for the GEOS library is
included in the `geos-3.3.3` directory under the terms given in
LICENSE_geos.

the land-sea mask, coastline, lake, river and political boundary data are extracted
The land-sea mask, coastline, lake, river and political boundary data are extracted
from datasets provided with the [Generic Mapping Tools (GMT)](http://gmt.soest.hawaii.edu)
and are included under the terms given in LICENSE_data.

Everything else (including src/_geos.c, and src/_geos.pyx):
Everything else (including `src/_geos.c`, and `src/_geos.pyx`):

copyright (c) 2011 by Jeffrey Whitaker.

Expand All @@ -63,7 +63,7 @@ PERFORMANCE OF THIS SOFTWARE.

see http://matplotlib.github.com/basemap/

see scripts in 'examples' directory for example usage.
see scripts in `examples` directory for example usage.

read the FAQ and/or email the matplotlib-users mailing list if
you have problems or questions.
Expand All @@ -72,13 +72,13 @@ you have problems or questions.

0. Install pre-requisite python modules numpy and matplotlib.

1. Then download basemap-X.Y.Z.tar.gz (approx 100 mb) from
1. Then download `basemap-X.Y.Z.tar.gz` (approx 100 mb) from
the [GitHub Releases](https://github.com/matplotlib/basemap/releases) page, unpack and cd to basemap-X.Y.Z.

2. Install the GEOS library. If you already have it on your
system, just set the environment variable GEOS_DIR to point to the location
of libgeos_c and geos_c.h (if libgeos_c is in /usr/local/lib and
geos_c.h is in /usr/local/include, set GEOS_DIR to /usr/local).
system, just set the environment variable `GEOS_DIR` to point to the location
of libgeos_c and geos_c.h (if libgeos_c is in `/usr/local/lib` and
geos_c.h is in `/usr/local/include`, set GEOS_DIR to `/usr/local`).
Then go to step (3). If you don't have it, you can build it from
the source code included with basemap by following these steps:

Expand All @@ -92,13 +92,13 @@ the source code included with basemap by following these steps:
```

3. cd back to the top level basemap directory (basemap-X.Y.Z) and
run the usual 'python setup.py install'. Check your installation
run the usual `python setup.py install`. Check your installation
by running "from mpl_toolkits.basemap import Basemap" at the python
prompt.

4. To test, cd to the examples directory and run 'python simpletest.py'.
4. To test, cd to the examples directory and run `python simpletest.py`.
To run all the examples (except those that have extra dependencies
or require an internet connection), execute 'python run_all.py'.
or require an internet connection), execute `python run_all.py`.

## Contact

Expand Down