Skip to main content

How to Setup the Development Environment

To setup the development environment, you need to install the repo utility and use the following repo manifest or any other configuration.

If you plan to use the readonly.xml and the repo utility you can run the following:

repo init -u https://github.com/osmandapp/OsmAnd-manifest -m readonly.xml
repo sync

You can also use just git and checkout the following git repositories to correct folder names:

  • Folder android - Osmand
    • git clone https://github.com/osmandapp/Osmand.git android
  • Folder ios - OsmAnd-ios
    • git clone https://github.com/osmandapp/OsmAnd-ios.git ios
  • Folder resources - OsmAnd-resources
    • git clone https://github.com/osmandapp/OsmAnd-resources.git resources
  • Folder core - OsmAnd-core
    • git clone https://github.com/osmandapp/OsmAnd-core.git core
  • Folder help - osmandapp.github.io
    • git clone https://github.com/osmandapp/osmandapp.github.io.git help
  • Folder core-legacy - OsmAnd-core-legacy
    • git clone https://github.com/osmandapp/OsmAnd-core-legacy.git core-legacy
  • Folder build - OsmAnd-build
    • git clone https://github.com/osmandapp/OsmAnd-build.git build
  • Folder tools - OsmAnd-tools (servers, map creation)
    • git clone https://github.com/osmandapp/OsmAnd-tools.git tools
  • Folder web - web (web-only)
    • git clone https://github.com/osmandapp/web.git web
  • Folder misc - OsmAnd-misc (standalone utilities)
    • git clone https://github.com/osmandapp/OsmAnd-misc.git misc

You might not need all repositories to get tools / android or ios working. You can always double check corresponding branches in repo-configurations.