From 6bfd58fba13be7fdadc308487b4a455f83d80636 Mon Sep 17 00:00:00 2001 From: Artem Vodolazskiy Date: Tue, 22 Dec 2015 18:10:49 +0300 Subject: [PATCH 1/4] Added warning to the README about using custom names for a cloned repository path --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 86a21291d7..f21b2736eb 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,8 @@ for [iOS](https://itunes.apple.com/app/id510623322) and This repository contains submodules. Clone it with `git clone --recursive`. If you forgot, run `git submodule update --init --recursive`. +Please due to some hard coded paths for development environment do not use custom names +for a repository root directory. At the moment it MUST remain "omim". ## Compilation From 0e42656f3f14c43ec7a91ad186667345673cbb14 Mon Sep 17 00:00:00 2001 From: Artem Vodolazskiy Date: Wed, 23 Dec 2015 14:22:17 +0300 Subject: [PATCH 2/4] changing warning place from README to CONTRIBUTING with more details --- README.md | 2 -- docs/CONTRIBUTING.md | 5 +++++ 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f21b2736eb..86a21291d7 100644 --- a/README.md +++ b/README.md @@ -9,8 +9,6 @@ for [iOS](https://itunes.apple.com/app/id510623322) and This repository contains submodules. Clone it with `git clone --recursive`. If you forgot, run `git submodule update --init --recursive`. -Please due to some hard coded paths for development environment do not use custom names -for a repository root directory. At the moment it MUST remain "omim". ## Compilation diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index af15445571..2d0682300f 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -43,6 +43,11 @@ See [INSTALL.md](INSTALL.md) for command-line compilation instructions. Debugging may not work in Qt Creator. To enable it, try creating a Build & Run kit in preferences with XCode's lldb as a debugger and a clang compiler. +For now configuration assumes you've cloned repository into omim (also a default name) directory. +Default building behaviour uses shadow-dir for artifacts. That is why if you break the first assumption +and haven't changed the second setting you'll need to create a "data" symlink in the shadow-dir path +to the /repo/data directory. + ### XCode * Install [Homebrew](http://brew.sh/) and run `brew install qt5`. From 6aeed5c11bbb0f16e537142f4344744c1835507c Mon Sep 17 00:00:00 2001 From: Artem Vodolazskiy Date: Thu, 24 Dec 2015 13:00:29 +0300 Subject: [PATCH 3/4] Fixed some language issues for pull request 1106 --- docs/CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 2d0682300f..d516677aaf 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -44,7 +44,7 @@ Debugging may not work in Qt Creator. To enable it, try creating a Build & Run k preferences with XCode's lldb as a debugger and a clang compiler. For now configuration assumes you've cloned repository into omim (also a default name) directory. -Default building behaviour uses shadow-dir for artifacts. That is why if you break the first assumption +Default QtCreator's building behavior uses shadow-dir for artifacts. That is why if you break the first assumption and haven't changed the second setting you'll need to create a "data" symlink in the shadow-dir path to the /repo/data directory. From e8838728cdfb6cf5531118c2a74d550748d0f316 Mon Sep 17 00:00:00 2001 From: Artem Vodolazskiy Date: Thu, 24 Dec 2015 14:05:38 +0300 Subject: [PATCH 4/4] Text refactoring for pull request 1106 --- docs/CONTRIBUTING.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index d516677aaf..d6665790c7 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -43,10 +43,9 @@ See [INSTALL.md](INSTALL.md) for command-line compilation instructions. Debugging may not work in Qt Creator. To enable it, try creating a Build & Run kit in preferences with XCode's lldb as a debugger and a clang compiler. -For now configuration assumes you've cloned repository into omim (also a default name) directory. -Default QtCreator's building behavior uses shadow-dir for artifacts. That is why if you break the first assumption -and haven't changed the second setting you'll need to create a "data" symlink in the shadow-dir path -to the /repo/data directory. +At the moment configuration assumes you've cloned repository into omim (also a default name) directory. +If you are using shadow-dir for building artifacts (default behavior) and custom directory for repo - +you'll need to create a "data" symlink in the shadow-dir path to the /repo/data directory. ### XCode