Skip to content

Commit 339f02e

Browse files
committed
Added more explanation
1 parent fa74600 commit 339f02e

File tree

1 file changed

+14
-8
lines changed

1 file changed

+14
-8
lines changed

README.md

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
# Mapcode Library for Python
1+
# Mapcode package for Python
22

33
Copyright (C) 2014-2015 Stichting Mapcode Foundation (http://www.mapcode.com)
44

55
----
66

7-
This Python project contains a library to encode latitude/longitude pairs to mapcodes
7+
This Python project contains a package to encode latitude/longitude pairs to mapcodes
88
and to decode mapcodes back to latitude/longitude pairs.
99

1010
If you wish to use mapcodes in your own application landscape, consider using running an instance of the
@@ -34,15 +34,20 @@ At the moment this module is still in development!
3434

3535
# Bug Reports and New Feature Requests
3636

37-
If you encounter any problems with this library, don't hesitate to use the `Issues` session to file your issues.
38-
Normally, one of our developers should be able to comment on them and fix.
37+
If you encounter any problems with this package, don't hesitate to use the `Issues` session to file your issues.
38+
Normally, one of our developers should be able to comment on them and fix.
3939

4040
# Prequisites
4141

42-
As the Python modules relies upon the Mapcode C library you will
42+
As the Python modules relies upon the Mapcode C library you will
4343
need to have a compiler installed to be able to build and install
4444
this module.
4545

46+
The assumption is that the mapcode-cpp source is available in
47+
../mapcode-cpp/mapcodelib, if it located in a different place you
48+
will have to update the include directory in setup.py
49+
50+
4651
# Installation
4752

4853
Get both the Python and C repositories using:
@@ -52,23 +57,24 @@ git clone https://github.com/mapcode-foundation/mapcode-cpp
5257
cd mapcode-python
5358
```
5459

55-
Compile the current directory using:
60+
Compile the package in current directory using:
5661

5762
```python setup.py --inplace
5863
```
5964

6065
Install in your Python environment using:
6166

62-
```cd mapcode-python
63-
python setup.py install
67+
```python setup.py install
6468
```
6569

70+
6671
# Usage
6772

6873

6974
```import mapcode
7075
7176
dir (mapcode)
77+
7278
print mapcode.__doc__
7379
print mapcode.version()
7480
print mapcode.decode('NLD 49.4V','')

0 commit comments

Comments
 (0)