Skip to content

Commit 78fcad2

Browse files
author
Henry Hammond
committed
Updated readme to use markdown
1 parent 35b9207 commit 78fcad2

File tree

1 file changed

+21
-19
lines changed

1 file changed

+21
-19
lines changed

README renamed to README.md

Lines changed: 21 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,28 @@
1-
**Descripton**
1+
#Basemap
22

3-
basemap - plot on map projections (with coastlines and political boundaries)
3+
Plot on map projections (with coastlines and political boundaries)
44
using matplotlib.
55

6-
**Requirements**
6+
##Requirements
77

8-
python 2.5 (or higher)
8+
* python 2.5 (or higher)
99

10-
matplotlib
10+
* matplotlib
1111

12-
numpy
12+
* numpy
1313

14-
The GEOS (Geometry Engine - Open Source) library (version 3.1.1 or higher).
14+
* The GEOS (Geometry Engine - Open Source) library (version 3.1.1 or higher).
1515
Source code is included in the geos-3.3.3 directory.
1616

17-
PIL (http://pythonware.com/products/pil) is optional (only
17+
* PIL (http://pythonware.com/products/pil) is optional (only
1818
needed for Basemap warpimage and bluemarble methods).
1919

20-
On linux, if your python was installed via a package management system, make
20+
* On linux, if your python was installed via a package management system, make
2121
sure the corresponding "python-dev" package is also installed. Otherwise, you
2222
may not have the python header (Python.h), which is required to build python
2323
C extensions.
2424

25-
**Copyright**
25+
##Copyright
2626

2727
source code from proj.4 (http://proj.maptools.org) is included in the
2828
'src' directory under the terms given in LICENSE_proj4.
@@ -61,7 +61,7 @@ USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
6161
OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
6262
PERFORMANCE OF THIS SOFTWARE.
6363

64-
**Documentation**
64+
##Documentation
6565

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

@@ -70,42 +70,44 @@ see scripts in 'examples' directory for example usage.
7070
read the FAQ and/or email the matplotlib-users mailing list if
7171
you have problems or questions.
7272

73-
**Install**
73+
##Install
7474

75-
0) Install pre-requisite python modules numpy and matplotlib.
75+
0. Install pre-requisite python modules numpy and matplotlib.
7676

77-
1) Then download basemap-X.Y.Z.tar.gz (approx 100 mb) from
77+
1. Then download basemap-X.Y.Z.tar.gz (approx 100 mb) from
7878
the sourceforge download site, unpack and cd to basemap-X.Y.Z.
7979

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

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

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

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

103-
**Contact**
105+
##Contact
104106

105107
Jeff Whitaker <[email protected]>
106108

107109

108-
**Thanks**
110+
##Thanks
109111

110112
to
111113

0 commit comments

Comments
 (0)