README.md 3.37 KB
Newer Older
axet's avatar
axet committed
1
2
3
4
5
6
7
8
9
# Features

Features over upstream repo:

  * Track Recording (record your tracks)
  * Custom Bookmarks path (helps backup your bookmarks with apps like: Syncthing)
  * Removed ads and binaries (peace and freedom)
  * Screenlock option (prevent app stay turned on while in pocket with lockscreen enabled)

10
11
# MAPS.ME

ForkWithMe's avatar
ForkWithMe committed
12
[MAPS.ME](https://maps.me) is an open source cross-platform offline maps application,
13
14
15
built on top of crowd-sourced OpenStreetMap data. It was publicly released
for [iOS](https://itunes.apple.com/app/id510623322) and
[Android](https://play.google.com/store/apps/details?id=com.mapswithme.maps.pro).
16

17
18
![](docs/screenshots.jpg)

Ilya Zverev's avatar
Ilya Zverev committed
19
20
21
22
23
## Submodules

This repository contains submodules. Clone it with `git clone --recursive`. If you forgot,
run `git submodule update --init --recursive`.

Alex Zolotarev's avatar
Alex Zolotarev committed
24
25
26
27
## Translations

If you want to improve app translations or add more search synonyms, please check our [wiki](https://github.com/mapsme/omim/wiki).

28
29
## Compilation

Ilya Zverev's avatar
Ilya Zverev committed
30
31
32
To compile the project, you would need to initialize private key files. Run
`configure.sh` and press Enter to create empty files, good enough to build desktop
and Android debug packages.
33
34
35
36
37
38

For detailed installation instructions and Android/iOS building process,
see [INSTALL.md](https://github.com/mapsme/omim/tree/master/docs/INSTALL.md).

## Building maps

39
To create one or many map files, first build the project, then use python module [maps_generator](https://github.com/mapsme/omim/tree/master/tools/python/maps_generator).
40
41
42
43

## Map styles

MAPS.ME uses its own binary format for map styles, `drules_proto.bin`, which is compiled from
44
[MapCSS](https://wiki.openstreetmap.org/wiki/MapCSS) using modified Kothic library.
45
46
47
48
49
50
51
52
53
54
55
56
Feature set in MWM files depends on a compiled style, so make sure to rebuild maps after
releasing a style.

For development, use MAPS.ME Designer app along with its generator tool: these allow
for quick rebuilding of a style and symbols, and for producing a zoom-independent
feature set in MWM files.

See [STYLES.md](https://github.com/mapsme/omim/tree/master/docs/STYLES.md) for the
format description, instructions on building a style and some links.

## Development

57
You would need Qt 5 for development, most other libraries are included into the
Ilya Zverev's avatar
Ilya Zverev committed
58
repository: see `3party` directory. The team uses mostly XCode and Qt Creator,
59
though these are not mandatory. We have an established
60
[c++ coding style](https://github.com/mapsme/omim/blob/master/docs/CPP_STYLE.md) and [Objective-C coding style](https://github.com/mapsme/omim/blob/master/docs/OBJC_STYLE.md).
61
62
63
64
65

See [CONTRIBUTING.md](https://github.com/mapsme/omim/blob/master/docs/CONTRIBUTING.md)
for the repository initialization process, the description of all the directories
of this repository and other development-related information.

Ilya Zverev's avatar
Ilya Zverev committed
66
67
68
All contributors must sign a [Contributor Agreement](https://github.com/mapsme/omim/blob/master/docs/CLA.md),
so both our and their rights are protected.

69
70
71
72
73
74
75
## Feedback

Please report bugs and suggestions to [the issue tracker](https://github.com/mapsme/omim/issues),
or by mail to bugs@maps.me.

## Authors and License

Marat's avatar
Marat committed
76
This source code is Copyright (C) 2020 My.com B.V. (Mail.Ru Group), published under Apache Public License 2.0,
77
except third-party libraries. See [NOTICE](https://github.com/mapsme/omim/blob/master/NOTICE)
78
and [data/copyright.html](http://htmlpreview.github.io/?https://github.com/mapsme/omim/blob/master/data/copyright.html) files for more information.