organicmaps/travelguide
Archived
13
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity Actions

Merge pull request #89 from deathbaba/generate-readme

Browse source 
Generate readme
This commit is contained in:
deathbaba 2013-11-05 23:14:00 -08:00
commit 3ecb18758e
1 changed files with 28 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
builder/wikivoyage/readme.md Normal file
View file

@ -0,0 +1,28 @@
# How to add country
To add new country to genenarion list follow next 3 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 files.
## More Android notes
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.