Skip to content

Commit 0a8aa58

Browse files
committed
Added Markdown in README
1 parent d9c6869 commit 0a8aa58

File tree

1 file changed

+19
-21
lines changed

1 file changed

+19
-21
lines changed

README renamed to README.md

Lines changed: 19 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
-------------------------------------------------------------------------------
21
MAPCODE LIBRARY FOR C/C++
3-
-------------------------------------------------------------------------------
2+
====
3+
44
Copyright (C) 2014 Stichting Mapcode Foundation (http://www.mapcode.com)
55

66
Licensed under the Apache License, Version 2.0 (the "License");
@@ -14,13 +14,13 @@ distributed under the License is distributed on an "AS IS" BASIS,
1414
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
1515
See the License for the specific language governing permissions and
1616
limitations under the License.
17+
1718
-------------------------------------------------------------------------------
1819

1920
Online documentation can be found at: http://rijnb.github.io/mapcode-cpp/
2021

21-
-------------------------------------------------------------------------------
22-
MAPCODE LIBRARY: mapcodelib/
23-
-------------------------------------------------------------------------------
22+
The C/C++ Library: mapcodelib/
23+
====
2424

2525
The directory 'mapcodelib' contains the files:
2626

@@ -41,9 +41,8 @@ In that case, basics.h will state a version number of the for:
4141
#define mapcode_cversion "1.2xxx"
4242
where "xxx" states the geographical limitation.
4343

44-
-------------------------------------------------------------------------------
45-
EXAMPLE: example/
46-
-------------------------------------------------------------------------------
44+
A real-life example, the 'mapcode' codec tool: example/
45+
====
4746

4847
The directory 'example' contains a Mapcode encoding/decoding utility, as an example
4948
of how to use the library.
@@ -58,50 +57,49 @@ This tool provides a rather extensive command-line interface to encode and
5857
decode Mapcodes.
5958

6059

61-
-------------------------------------------------------------------------------
62-
MAPCODE LIBRARY - RELEASE NOTES
63-
-------------------------------------------------------------------------------
60+
Release notes
61+
====
6462

65-
1.40
63+
* 1.40
6664

6765
Added extraDigits parameter to allow high-precision mapcodes to be generated.
6866

69-
1.33
67+
* 1.33
7068

7169
Fix to not remove valid results just across the edge of a territory.
7270
Improved interface readability and renamed methods to more readable forms.
7371

74-
1.32
72+
* 1.32
7573

7674
Added encodeLatLonToSingleMapcode(); fixed 1.29 so no country-wide alternative
7775
is produced in edge cases; prevent FIJI failing to decode at exactly 180 degrees.
7876

79-
1.31
77+
* 1.31
8078

8179
Added compareWithMapcodeFormat().
8280

83-
1.30
81+
* 1.30
8482

8583
IUpdated the documentation and extended it with examples and suggestions.
8684

87-
1.29
85+
* 1.29
8886

8987
Also generate country-wide alternative mapcodes for states.
9088

91-
1.28
89+
* 1.28
9290

9391
Bug fix for the needless generation of 7-letter alternatives to short mapcodes
9492
in large states in India.
9593

96-
1.27
94+
* 1.27
9795

9896
Improved (faster) implementation of the function isInArea.
9997

100-
1.26
98+
* 1.26
10199

102100
Added alias OD ("Odisha") for indian state OR ("Orissa").
103101

104-
1.25
102+
* 1.25
105103

106104
Initial release to the public domain.
107105

0 commit comments

Comments
 (0)