Offline GuideWithMe travel guides based on Wikivoyage articles.
This repository has been archived on 2025-03-22. You can view files and clone it, but cannot push or open issues or pull requests.
Find a file
2013-11-14 21:14:44 +03:00
3rdparty [build] tools versions up 2013-09-26 19:13:19 +03:00
android [android] Added default icons 2013-11-14 17:50:59 +03:00
builder Moved readme.md to the root 2013-11-12 15:53:19 +03:00
data Fixed "selection" on section header tap 2013-10-15 17:54:33 +03:00
env Added CONFIG+=debug and CONFIG+=release support 2013-09-25 19:32:39 +02:00
iOS [ios] Increased version 2013-11-14 21:14:44 +03:00
std Changed str::Tokenizer semantics (pass functor instead of iterator). 2013-08-12 22:14:30 +03:00
storage [and] Compilation fix. 2013-10-08 16:07:43 +03:00
tools [tools] Added android jobb utility to automatically build obb files 2013-08-12 20:40:14 +03:00
.gitignore [build] Moved countries data to separate folder. 2013-10-03 14:49:40 +02:00
defines.pri Added CONFIG+=debug and CONFIG+=release support 2013-09-25 19:32:39 +02:00
readme.md [android] Readme: add icons for every new country 2013-11-14 17:36:24 +03:00
tests.pro Added storage index builder. 2013-08-07 22:51:21 +03:00

How to build guide for a new country

To add new country to generation list please follow next steps:

  1. Add country's name from file all_countries.txt to file countries_to_generate.txt
  2. Add default image for this country into the folder default_images this image will be used for articles which don't have image (or we dont have image for them). It's name must be <country_name>.jpg.
  3. Remove file process_html if exists to update data.

Now you'r ready to build new amazing guides with me!

  • run bash build.sh to prepare data for guides and Android obb files.

iOS - add new country

  1. Duplicate any existing iOS target and give it a name of new country
  2. Set PRODUCT_NAME in target project properties equal to a name of new country
  3. Set BUNDLE_ID in target properties to com.guidewithme.newcountry (all lowercase)
  4. Set URL_SCHEME in target properties to guidewithme-newcountry (all lowercase)
  5. Add all necessary app icons to the corresponding folder
  6. Add new target name to iOS/build.sh to use Jenkins autobuild
  7. Create new app/key in Flurry and add it to iOS/offlineguides/Statistics.m file

To build new guide locally from XCode, you should copy guide data generated by builder to iOS/Countries/New_Country folder. In this folder there is content/data folder with *.html files, css, js, images and thumb subfolders

Android notes

IMPORTANT

  • Don't forget to edit file android/src/com/guidewithme/expansion/KeyMap.java Please add Google Play public license key at the end of the COUTRY_2_KEY map AND increment KEY_COUNT constant.
  • Add icons for every resolution to android/icons/CountryName/

There is one script you need to use to build guides for Android: build-with-android.sh. It places it's result (obb, apk) into countries folder Countries/<country_name>.

Android applications have package name made of lowercased country name and underscores replaced with dotes, added to "com.guidewithme.". For instance: United_States -> com.guidewithme.united.states

United_Kingdom hack

We have package name "com.guidewithme.uk" for it for the sake compatibility with first release. obb and apk files are generated accordingly.