If you would like to add a new location table to the database, follow the instructions here.
First of all, make sure you have permission to import the location table into a database which will be distributed with the source code of an application, free of charge. Do not import a location table if you are not positively sure you have permission!
Licensing of location tables varies greatly, from Creative Commons licenses to proprietary agreements with tight restrictions on redistribution. If redistribution is restricted (which is the default assumption if you need to sign an agreement before you get the data), check the conditions carefully. Importing the database means that its data will end up on a public repository. Some data is omitted, and the rest is transformed into a SQL database. However, no access restrictions are in place and a technically savvy user could use the data for other purposes. Check with the copyright owner if you are unsure if that is covered by the agreement.
Once you have verified that you have permission to import the database, follow these steps:
- Clone Qz (if you have not already done so), or pull the latest updates.
- Save the license agreement in the
- Extract the new TMC location table to a folder of your choice, outside the Qz code tree. You should have a directory for the location tables, with one subdirectory for each location table (containing the .DAT files). None of these files will be committed to the git repository, so keep them out of the code tree.
- Make sure you can build Qz by running
./gradlew buildfrom the root directory of the code tree.
- In the Qz code directory, run
/path/to/your/ltis your location table directory).
- If you import a location table that is not in the database yet, it will be added.
- If you import a newer version of a location table that is already in the database, it will replace the existing one.
- If you import a location table which is already in the database and your LT is not newer than the version in the database, your version will be skipped.
- All other location tables in the database will remain untouched.
- Stage your changes. They should consist of the following files:
extra/ltdb-licenses/license-??.*(unless you are updating an existing location table for which we already have the license).
- Commit your changes and file a merge request (or push it directly, if you have permission to).