|
| 1 | +# Mapcode Library for Python |
| 2 | + |
| 3 | +Copyright (C) 2014-2015 Stichting Mapcode Foundation (http://www.mapcode.com) |
| 4 | + |
| 5 | +---- |
| 6 | + |
| 7 | +This Puthon project contains a library to encode latitude/longitude pairs to mapcodes |
| 8 | +and to decode mapcodes back to latitude/longitude pairs. |
| 9 | + |
| 10 | +If you wish to use mapcodes in your own application landscape, consider using running an instance of the |
| 11 | +Mapcode REST API, which can be found on: **https://github.com/mapcode-foundation/mapcode-rest-service** |
| 12 | + |
| 13 | +# License |
| 14 | + |
| 15 | +Licensed under the Apache License, Version 2.0 (the "License"); |
| 16 | +you may not use this file except in compliance with the License. |
| 17 | +You may obtain a copy of the License at |
| 18 | + |
| 19 | + http://www.apache.org/licenses/LICENSE-2.0 |
| 20 | + |
| 21 | +Unless required by applicable law or agreed to in writing, software |
| 22 | +distributed under the License is distributed on an "AS IS" BASIS, |
| 23 | +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 24 | +See the License for the specific language governing permissions and |
| 25 | +limitations under the License. |
| 26 | + |
| 27 | +Original C library created by Pieter Geelen. Work on Java version |
| 28 | +of the mapcode library by Rijn Buve and Matthew Lowden. |
| 29 | + |
| 30 | +# Using Git and `.gitignore` |
| 31 | + |
| 32 | +It's good practice to set up a personal global `.gitignore` file on your machine which filters a number of files |
| 33 | +on your file systems that you do not wish to submit to the Git repository. You can set up your own global |
| 34 | +`~/.gitignore` file by executing: |
| 35 | +`git config --global core.excludesfile ~/.gitignore` |
| 36 | + |
| 37 | +In general, add the following file types to `~/.gitignore` (each entry should be on a separate line): |
| 38 | +`*.com *.class *.dll *.exe *.o *.so *.log *.sql *.sqlite *.tlog *.epoch *.swp *.hprof *.hprof.index *.releaseBackup *~` |
| 39 | + |
| 40 | +If you're using a Mac, filter: |
| 41 | +`.DS_Store* Thumbs.db` |
| 42 | + |
| 43 | +If you're using IntelliJ IDEA, filter: |
| 44 | +`*.iml *.iws .idea/` |
| 45 | + |
| 46 | +If you're using Eclips, filter: |
| 47 | +`.classpath .project .settings .cache` |
| 48 | + |
| 49 | +If you're using NetBeans, filter: |
| 50 | +`nb-configuration.xml *.orig` |
| 51 | + |
| 52 | +The local `.gitignore` file in the Git repository itself to reflect those file only that are produced by executing |
| 53 | +regular compile, build or release commands, such as: |
| 54 | +`target/ out/` |
| 55 | + |
| 56 | +# Bug Reports and New Feature Requests |
| 57 | + |
| 58 | +If you encounter any problems with this library, don't hesitate to use the `Issues` session to file your issues. |
| 59 | +Normally, one of our developers should be able to comment on them and fix. |
0 commit comments