diff --git a/readme.md b/readme.md index fda6300..024b24a 100644 --- a/readme.md +++ b/readme.md @@ -1,18 +1,31 @@ -# How to add country +# How to build guide for a new country -To add new country to genenarion list follow next 3 steps: +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* +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. +* run `bash build.sh` to prepare data for guides and Android obb files. -## More Android notes +## 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 + +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 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