Skip to content

Commit 403c19f

Browse files
molinavmolinav
committed
Refactor README content
1 parent d578a20 commit 403c19f

File tree

1 file changed

+42
-38
lines changed

1 file changed

+42
-38
lines changed

‎README.md‎

Lines changed: 42 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -12,41 +12,41 @@ using matplotlib.
1212

1313
* matplotlib
1414

15-
* numpy
15+
* numpy
1616

1717
* [pyproj](https://github.com/jswhit/pyproj)
1818

1919
* [pyshp](https://github.com/GeospatialPython/pyshp)
2020

2121
* The GEOS (Geometry Engine - Open Source) library (version 3.1.1 or higher).
22-
Source code is included in the geos-3.3.3 directory.
22+
Source code is included in the `geos-3.3.3` directory.
2323

24-
* On linux, if your python was installed via a package management system, make
25-
sure the corresponding "python-dev" package is also installed. Otherwise, you
26-
may not have the python header (`Python.h`), which is required to build python
24+
* On Linux, if your Python was installed via a package management system, make
25+
sure the corresponding `python-dev` package is also installed. Otherwise, you
26+
may not have the Python header (`Python.h`), which is required to build Python
2727
C extensions.
2828

2929
### Optional
3030

31-
* [OWSLib](https://github.com/geopython/OWSLib) (optional) It is needed
32-
for the BaseMap.wmsimage function.
31+
* [OWSLib](https://github.com/geopython/OWSLib) (optional) It is needed for
32+
the `BaseMap.wmsimage` function.
3333

34-
* [Pillow](https://python-pillow.github.io/) (optional) It is
35-
needed for Basemap warpimage, bluemarble, shadedrelief, and etop methods.
36-
PIL should work on Python 2.x. Pillow is a maintained fork of PIL.
34+
* [Pillow](https://python-pillow.github.io/) (optional) It is needed for
35+
Basemap warpimage, bluemarble, shadedrelief, and etop methods. PIL should
36+
work on Python 2.x. Pillow is a maintained fork of PIL.
3737

3838
## Copyright
3939

40-
Source code for the GEOS library is
41-
included in the `geos-3.3.3` directory under the terms given in
42-
LICENSE_geos.
40+
Source code for the GEOS library is included in the `geos-3.3.3` directory
41+
under the terms given in `LICENSE_geos`.
4342

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

4848
Everything else (including `src/_geos.c` and `src/_geos.pyx`) is licensed under
49-
the terms given in LICENSE:
49+
the terms given in `LICENSE`:
5050

5151
Copyright (C) 2011 Jeffrey Whitaker
5252

@@ -64,44 +64,44 @@ USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
6464
OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
6565
PERFORMANCE OF THIS SOFTWARE.
6666

67-
## Documentation
67+
## Documentation
6868

69-
see http://matplotlib.github.com/basemap/
69+
See http://matplotlib.github.com/basemap/
7070

71-
see scripts in `examples` directory for example usage.
71+
See scripts in `examples` directory for example usage.
7272

73-
read the FAQ and/or email the matplotlib-users mailing list if
74-
you have problems or questions.
73+
Read the FAQ and/or email the matplotlib-users mailing list if you have
74+
problems or questions.
7575

7676
## Install
7777

78-
0. Install pre-requisite python modules numpy and matplotlib.
78+
0. Install pre-requisite Python modules numpy and matplotlib.
7979

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

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

9091
```
9192
> cd geos-3.3.3
9293
> export GEOS_DIR=<where you want the libs and headers to go>
9394
A reasonable choice on a Unix-like system is /usr/local, or
9495
if you don't have permission to write there, your home directory.
95-
> ./configure --prefix=$GEOS_DIR
96+
> ./configure --prefix=$GEOS_DIR
9697
> make; make install
9798
```
9899

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

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

@@ -117,4 +117,8 @@ Ben Root <ben.v.root@gmail.com>
117117

118118
## Thanks
119119

120-
Special thanks to John Hunter, Andrew Straw, Eric Firing, Rob Hetland, Scott Sinclair, Ivan Lima, Erik Andersen, Michael Hearne, Jesper Larsen, Ryan May, David Huard, Mauro Cavalcanti, Jonas Bluethgen, Chris Murphy, Pierre Gerard-Marchant, Christoph Gohlke, Eric Bruning, Stephane Raynaud, Tom Loredo, Patrick Marsh, Phil Elson, and Henry Hammond for valuable contributions.
120+
Special thanks to John Hunter, Andrew Straw, Eric Firing, Rob Hetland, Scott
121+
Sinclair, Ivan Lima, Erik Andersen, Michael Hearne, Jesper Larsen, Ryan May,
122+
David Huard, Mauro Cavalcanti, Jonas Bluethgen, Chris Murphy, Pierre
123+
Gerard-Marchant, Christoph Gohlke, Eric Bruning, Stephane Raynaud, Tom Loredo,
124+
Patrick Marsh, Phil Elson, and Henry Hammond for valuable contributions.

0 commit comments

Comments
 (0)