kumi/distancefinder
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

Convert README to markdown

Browse source
This commit is contained in:
Klaus-Uwe Mitterer 2016-08-07 22:17:25 +02:00
parent c5b58929fe
commit 1a1bc4cf73
1 changed files with 20 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

30
README
View file

@ -1,27 +1,37 @@
= Distance Finder =
Distance Finder
===============
PHP script allowing users to find the air distance between cities. Uses information from Google if data not found in local database.
PHP script allowing users to find the air distance between cities. Uses
information from Google if data not found in local database.
== License ==
License
-------
Distance Finder by Klaus-Uwe Mitterer is licensed under the Creative Commons Attribution-ShareAlike 3.0 Unported License. To view a copy of this license, visit http://creativecommons.org/licenses/by-sa/3.0/.
None, yet. I'll have to come up with something.
Permissions beyond the scope of this license may be available at info@klaus-uwe.me.
== Installation ==
Installation
------------
Change the following settings in bootstrap.php:
```
DB_HOST = The host on which your MySQL database is running. Usually localhost.
DB_NAME = The name of your MySQL database.
DB_USER = The user name for your MySQL database.
DB_PASSWORD = The corresponding password.
CSVFILE = The file you want to import to the database. Has to be in the following format: City name, Country code, State code, Population, Latitude, Longitude. Can be an empty file. Make sure this file exists in the same folder as the install.php
CSVFILE = The file you want to import to the database. Has to be in the
following format: City name, Country code, State code, Population,
Latitude, Longitude. Can be an empty file. Make sure this file exists
in the same folder as the install.php
```
Then go to http://yoursite.com/[subdirectory]/install.php and follow the instructions. Depending on the size of the CSV file you are importing into the database, this might take a while.
When the installation has finished, you might want to remove or rename install.php.
== Troubleshooting ==
Troubleshooting
---------------
If you keep getting empty files when trying to download the distance list, make sure that the web server has permissions to write in the folder (e.g. chown www-data:www-data)
If you keep getting empty files when trying to download the distance list, make
sure that the web server has permissions to write in the folder
(e.g. chown www-data:www-data)