diff --git a/docs/INSTALL.md b/docs/INSTALL.md index e5680cd9f..6bc867a3b 100644 --- a/docs/INSTALL.md +++ b/docs/INSTALL.md @@ -21,7 +21,9 @@ Clone the repository including all submodules (see [Special cases options](#spec Follow the instructions for your OS, and afterwards the repository is prepared to build a CoMaps app! -### Linux +## Setting up to your OS of development +
+ Linux Clone the repository ```bash git clone --recurse-submodules --shallow-submodules https://codeberg.org/comaps/comaps.git @@ -41,7 +43,10 @@ cd comaps If you plan to publish the app privately in stores check [special options](#special-cases-options). -### Windows +
+ +
+ Windows You need to have [Git for Windows](https://git-scm.com/download/win) installed and Git bash available in the PATH. It's necessary to enable symlink support: @@ -69,7 +74,11 @@ For _Windows 10_: You should be able to build the project by following either o **Setup 2: Using Visual Studio Developer Command Prompt** Install the [Visual Studio Developer Command Prompt](https://docs.microsoft.com/en-us/visualstudio/ide/reference/command-prompt-powershell?view=vs-2022) (make sure to choose the latest MSVC x64/x86 build tool and Windows 10/11 SDK as individual components while installing Visual Studio). -### macOS +
+ +
+ macOS + Install required build dependencies and Xcode 1. Install Xcode Command Line Tools 2. Install [Xcode](https://apps.apple.com/app/xcode/id497799835?mt=12) from the App Store @@ -93,8 +102,10 @@ git clone --recurse-submodules --shallow-submodules https://codeberg.org/comaps/ cd comaps ./configure.sh ``` +
-### Special cases options +
+ Special cases options If you're only doing a one-off build or your internet bandwidth or disk space is limited, add following options to the `git clone` command: @@ -114,7 +125,11 @@ It'll seamlessly replace the squashed first "Organic Maps sources as of 02.04.20 The `om-historic.git` repo is ~1Gb only as various historic blobs, bundled 3rd-party deps, etc. were removed from it. If you really need them (e.g. to build a very old app version) then refer to full organicmaps.git repo please. -## Android app +
+ +## Develop for: +
+ Android app ### Preparing @@ -199,9 +214,10 @@ To enable logging in case of crashes, after installing a debug version, run: ```bash adb shell pm grant app.organicmaps.debug android.permission.READ_LOGS ``` +
- -### Android Auto Development +
+ Android Auto Android Auto can be developed and tested without having a physical device by using [Desktop Head Unit (DHU)](https://developer.android.com/training/cars/testing/dhu). Go to Android Studio > Tools -> SDK Manager -> SDK Tools and enable "Android Auto Desktop Head Unit". @@ -349,8 +365,10 @@ Example of command line for running system tracing: ``` ./record_android_trace -a app.organicmaps.debug -o trace_file.perfetto-trace -t 30s -b 64mb sched freq idle am wm gfx view binder_driver hal dalvik camera input res memory ``` +
-## iOS app +
+ iOS app ### Preparing @@ -401,7 +419,11 @@ Select "CoMaps" product scheme. Compile and run the project ("Product" → "Run"). -### CarPlay +
+ +
+ CarPlay + To test CarPlay, simply select "I/O" → "External Displays" → "CarPlay" in the Simulator ### Spoofing GPS @@ -411,6 +433,8 @@ To select an Apple predetermined track or specific custom location, choose "Feat To simulate a custom GPX track use `python3 tools/python/ios_simulator_load_gpx.py ` which is a wrapper for `xcrun simctl location`. Default values are 60 km/h and 0.1s update intervals, but can be customized +
+ ## Desktop app See [install_desktop](INSTALL_DESKTOP.md) to install and build Desktop app for Linux and Mac OS