Rebrand repository documentation

Signed-off-by: jeanbaptisteC <jeanbaptistec@noreply.codeberg.org>
This commit is contained in:
Jean-Baptiste
2025-05-04 15:49:24 +02:00
committed by Konstantin Pastbin
parent f6ebf9fcd4
commit c36a9e8c63
11 changed files with 65 additions and 69 deletions

View File

@@ -9,13 +9,13 @@
## System requirements
To build and run Organic Maps you'll need a machine with at least 4Gb of RAM and 20-30Gb of disk space depending on your target platform. Expect to download 5-10Gb of files.
To build and run CoMaps you'll need a machine with at least 4Gb of RAM and 20-30Gb of disk space depending on your target platform. Expect to download 5-10Gb of files.
For _Windows_ you need to have [Git for Windows](https://git-scm.com/download/win) installed and Git bash available in the PATH.
## Getting sources
First of all get the source code. The full Organic Maps sources repository is ~10Gb in size, there are various [clone options](#special-cases-options) to reduce the download size to suit your needs.
First of all get the source code. The full CoMaps sources repository is ~10Gb in size, there are various [clone options](#special-cases-options) to reduce the download size to suit your needs.
For _Windows_, it's necessary to enable symlink support:
1. Activate _Windows Development Mode_ to enable symlinks globally:
@@ -29,15 +29,15 @@ git config --global core.symlinks true
Clone the repository including all submodules (see [Special cases options](#special-cases-options) below):
(if you plan to contribute and propose pull requests then use a web interface at https://github.com/organicmaps/organicmaps to fork the repository first and use your fork's URL in the command below)
(if you plan to contribute and propose pull requests then use a web interface at https://codeberg.com/comaps/comaps to fork the repository first and use your fork's URL in the command below)
```bash
git clone --recurse-submodules --shallow-submodules https://github.com/organicmaps/organicmaps.git
git clone --recurse-submodules --shallow-submodules https://codeberg.com/comaps/comaps.git
```
Go into the cloned repository:
```bash
cd organicmaps
cd comaps
```
Configure the repository (make sure you have a working C++ build environment):
@@ -80,7 +80,7 @@ Check `./configure.sh --help` to see how to copy the configs automatically from
### Preparing
You need a Linux or a MacOS machine to build a desktop version of Organic Maps. [Windows](#windows) users can use the [WSL](https://learn.microsoft.com/en-us/windows/wsl/) (Windows Subsystem for Linux) and follow ["Linux or Mac"](#linux-or-mac) steps described below.
You need a Linux or a MacOS machine to build a desktop version of CoMaps. [Windows](#windows) users can use the [WSL](https://learn.microsoft.com/en-us/windows/wsl/) (Windows Subsystem for Linux) and follow ["Linux or Mac"](#linux-or-mac) steps described below.
### Linux or MacOS
@@ -185,9 +185,7 @@ brew install cmake ninja qt@6
### Windows
We haven't compiled Organic Maps on Windows *natively* in a long time, though it is possible.
Some files should be updated. There is a work in progress on [windows](https://github.com/organicmaps/organicmaps/tree/windows) branch.
Please contribute if you have time.
We haven't compiled CoMaps on Windows *natively* in a long time, somes adaptations is required to support Windows.
You'll need to have python3, cmake, ninja, and QT6 in the PATH, and Visual Studio 2022 or Visual Studio 2022 Build Tools installed. Use [Visual Studio Developer Command Prompt](https://learn.microsoft.com/en-us/visualstudio/ide/reference/command-prompt-powershell?view=vs-2022) or generate Visual Studio project files with CMake to build the project.
However, it is possible to use the WSL (Windows Subsystem for Linux) to run GUI applications.
@@ -287,7 +285,7 @@ ctest -R "base_tests|coding_tests" --output-on-failure
ctest -L "omim-test" -E "base_tests|coding_tests" --output-on-failure
```
Some tests [are known to be broken](https://github.com/organicmaps/organicmaps/issues?q=is%3Aissue+is%3Aopen+label%3ATests) and disabled on CI.
Some tests [are known to be broken](https://codeberg.com/comaps/comaps/issues?q=is%3Aissue+is%3Aopen+label%3ATests) and disabled on CI.
### Test Coverage
@@ -338,7 +336,7 @@ Steps to generate coverage report:
### Debug commands
Organic Maps has some "hidden" debug commands that you can trigger by entering them into the search box.
CoMaps has some "hidden" debug commands that you can trigger by entering them into the search box.
For example you can switch theme which is very useful for checking [styles](STYLES.md) changes.
To switch themes you can enter this commands:
@@ -386,7 +384,7 @@ The `build_omim.sh` script basically runs these commands:
### Preparing
Linux, MacOS, or Windows should work to build Organic Maps for Android.
Linux, MacOS, or Windows should work to build CoMaps for Android.
Ensure that you have at least 30GB of free space and Python 3 installed.
@@ -489,7 +487,7 @@ To run Android Auto, connect the phone using USB cable and run the Desktop Head
[I]: Attached!
```
Organic Maps icon will appear in the application list in DHU.
CoMaps icon will appear in the application list in DHU.
### More options
@@ -622,7 +620,7 @@ Example of command line for running system tracing:
### Preparing
Building Organic Maps for iOS requires a Mac.
Building CoMaps for iOS requires a Mac.
Ensure that you have at least 20GB of free space.
@@ -634,7 +632,7 @@ xcode-select --install
Then, install [Xcode](https://apps.apple.com/app/xcode/id497799835?mt=12) from the App Store.
Enroll in the [Apple Developer Program](https://developer.apple.com/programs/) (you can run Organic Maps in Simulator without this step).
Enroll in the [Apple Developer Program](https://developer.apple.com/programs/) (you can run CoMaps in Simulator without this step).
### Configuring Xcode
@@ -656,7 +654,7 @@ Reconfigure the project to use your developer signing keys:
- Choose a unique bundle identifier (not app.organicmaps.debug) and your team.
- Select "Automatically manage signing".
If you want to run Organic Maps on a real device, you have to remove the CarPlay entitlement. Open `iphone/Maps/OMaps-Debug.entitlements`
If you want to run CoMaps on a real device, you have to remove the CarPlay entitlement. Open `iphone/Maps/OMaps-Debug.entitlements`
and remove the `com.apple.developer.carplay-maps` entry. Now you can sign your app again in the "Signing & Capabilities" tab. Testing CarPlay
on a real device requires [requesting entitlements from Apple](https://developer.apple.com/documentation/carplay/requesting_carplay_entitlements).
@@ -672,4 +670,4 @@ Select "OMaps" product scheme.
Compile and run the project ("Product" → "Run").
## Map data and styles
See readme for the [map generator](https://github.com/organicmaps/organicmaps/blob/master/docs/MAPS.md) and [styles](https://github.com/organicmaps/organicmaps/blob/master/docs/STYLES.md) if you need to customize the map files and styles.
See readme for the [map generator](MAPS.md) and [styles](STYLES.md) if you need to customize the map files and styles.

View File

@@ -408,6 +408,6 @@ If a method declaration/call does not fit on a single line, put each parameter o
## Objective-C and C++
In general, C++ should be avoided in iOS-specific code. C++ can only be used when you need to call our Core API. In this case you should create some adapter classes which will work with both Objective-C and Swift. If .mm file contains C++ class, all code inside that class should be formatted according to [C++ coding style](https://github.com/organicmaps/organicmaps/blob/master/docs/CPP_STYLE.md), even if it contains Objective-C code lines.
In general, C++ should be avoided in iOS-specific code. C++ can only be used when you need to call our Core API. In this case you should create some adapter classes which will work with both Objective-C and Swift. If .mm file contains C++ class, all code inside that class should be formatted according to [C++ coding style](CPP_STYLE.md), even if it contains Objective-C code lines.
C++ can't be used in Objective-C header files.

View File

@@ -4,11 +4,11 @@
### Upload metadata and screenshots to the App Store
Use [GitHub Actions](../.github/workflows/ios-release.yaml).
Use [Forgejo Actions](../.forgejo/workflows/ios-release.yaml).
### Check metadata
Use [GitHub Actions](../.github/workflows/ios-check.yaml).
Use [Forgejo Actions](../.forgejo/workflows/ios-check.yaml).
Local check:
@@ -40,21 +40,21 @@ cd xcode
### Upload metadata and screenshots to Google Play
Use [GitHub Actions](../.github/workflows/android-release-metadata.yaml).
Use [Forgejo Actions](../.forgejo/workflows/android-release-metadata.yaml).
### Uploading a new version to Google Play
Use [GitHub Actions](../.github/workflows/android-release.yaml).
Use [Forgejo Actions](../.forgejo/workflows/android-release.yaml).
Promote version to "Production" manually in Google Play Console.
### Uploading a new version to Huawei AppGallery
Use [GitHub Actions](../.github/workflows/android-release.yaml).
Use [Forgejo Actions](../.forgejo/workflows/android-release.yaml).
### Checking metadata
Use [GitHub Actions](../.github/workflows/android-check.yaml).
Use [Forgejo Actions](../.forgejo/workflows/android-check.yaml).
Checking locally:

View File

@@ -1,8 +1,6 @@
# Roadmap
The Organic Maps project uses [Github Discussions](https://github.com/organicmaps/organicmaps/discussions/categories/ideas) to define its roadmap. ROADMAP.md files are common in open source projects but we find they quickly become out of date. We opt for an issues and milestone approach that our maintainers and community can keep up-to-date as work is added and completed.
## Milestones
Milestones define when an issue, pull request, and/or roadmap item is to be completed. Issues are the what, milestones are the when. Development is complex therefore roadmap items can move between milestones depending on the remaining development and testing required to release a change.
[View active milestones](https://github.com/organicmaps/organicmaps/milestones).
[View active milestones](https://codeberg.com/comaps/comaps/milestones).

View File

@@ -10,14 +10,14 @@ Here is the basic workflow to update styles:
Please prepend `[styles]` to your commit message and add [Developers Certificate of Origin](CONTRIBUTING.md#legal-requirements) to it.
Files changed by the script should be added as a separate `[styles] Regenerated` commit.
Please check [a list of current styling issues](https://github.com/organicmaps/organicmaps/issues?q=is%3Aopen+is%3Aissue+label%3AStyles)
and ["icons wanted" issues](https://github.com/organicmaps/organicmaps/issues?q=is%3Aopen+is%3Aissue+label%3AIcons+label%3A%22Good+first+issue%22).
Please check [a list of current styling issues](https://codeberg.com/comaps/comaps/issues?q=is%3Aopen+is%3Aissue+label%3AStyles)
and ["icons wanted" issues](https://codeberg.com/comaps/comaps/issues?q=is%3Aopen+is%3Aissue+label%3AIcons+label%3A%22Good+first+issue%22).
An overview of currently used icons can be found in the [Wiki](https://github.com/organicmaps/organicmaps/wiki/Icons).
An overview of currently used icons can be found in the [Wiki](https://codeberg.com/comaps/comaps/wiki/Icons).
## Requirements
To work with styles first [clone the OM repository](INSTALL.md#getting-sources).
To work with styles first [clone the CoMaps repository](INSTALL.md#getting-sources).
Install a `protobuf` python package with `pip`
```
@@ -107,7 +107,7 @@ A whole map needs to be [regenerated](MAPS.md) for the changes to take effect if
Map style files syntax is based on [MapCSS/0.2](https://wiki.openstreetmap.org/wiki/MapCSS/0.2),
though the specification is not supported in full and there are OM-specific extensions to it.
The `tools/unix/generate_drules.sh` script uses a customized version of [Kothic](https://github.com/organicmaps/kothic)
The `tools/unix/generate_drules.sh` script uses a customized version of [Kothic](https://codeberg.com/comaps/kothic)
stylesheet processor to compile MapCSS files into binary drawing rules files `data/drules_proto*.bin`.
The processor also produces text versions of these files (`data/drules_proto*.txt`) to ease debugging.

View File

@@ -1,9 +1,9 @@
# Subway layer generation
For the subway layer to be available in Organic Maps, a `SUBWAY_URL`
For the subway layer to be available in CoMaps, a `SUBWAY_URL`
parameter ought to be provided to the
[map generator](https://github.com/organicmaps/organicmaps/tree/master/tools/python/maps_generator).
Normally you can specify this link https://cdn.organicmaps.app/subway.json,
[map generator](https://codeberg.com/comaps/comaps/tree/master/tools/python/maps_generator).
Normally you can specify this link https://cdn.comaps.app/subway.json,
which provides a regularly updated file.
These instructions describe how to manually build a subway layer file.
@@ -21,7 +21,7 @@ whole planet is also applicable.
If you already have some not too outdated \*.o5m version, it is enough
because the subway generation script will update it with `osmupdate`.
1. With the [Organic Maps subways](https://github.com/organicmaps/subways) repository deployed,
1. With the [CoMaps subways](https://codeberg.com/comaps/subways) repository deployed,
run `scripts/process_subways.sh` bash script or prepare your own script
which launches `process_subways.py` and `validation_to_html.py` scripts
with suitable options.

View File

@@ -1,24 +1,24 @@
# Teams
Organic Maps is led by community contributors, with functional domains occasionally establishing or dissolving their leadership structures, formal or informal. This file outlines the functional project structure that has evolved over time. The current list of teams is available on [GitHub](https://github.com/orgs/organicmaps/teams), accessible only to [GitHub Org members](https://github.com/orgs/organicmaps/people) due to the limitations of GitHub.
CoMaps is led by community contributors, with functional domains occasionally establishing or dissolving their leadership structures, formal or informal. This file outlines the functional project structure that has evolved over time. The current list of teams is available on [Codeberg](https://codeberg.com/orgs/comaps/teams).
Teams are typically assigned as code owners for certain sections of the repository. GitHub will automatically request a review from the responsible team when changes are made to the relevant part of the repository in a pull request. See the [CODEOWNERS](../.github/CODEOWNERS) file for more information. Please feel free to tag the relevant team in the comments if you need assistance in a specific area. If you are unsure which team to contact, please tag [@organicmaps/triage](https://github.com/orgs/organicmaps/teams/contributors/triage) for help.
Teams are typically assigned as code owners for certain sections of the repository. Codeberg will automatically request a review from the responsible team when changes are made to the relevant part of the repository in a pull request. See the [CODEOWNERS](../.forgejo/CODEOWNERS) file for more information. Please feel free to tag the relevant team in the comments if you need assistance in a specific area. If you are unsure which team to contact, please tag [@comaps/triage](https://codeberg.com/orgs/comaps/teams/contributors/triage) for help.
## Triage
- [@organicmaps/triage](https://github.com/orgs/organicmaps/teams/triage/members)
- [@comaps/triage](https://github.com/orgs/comaps/teams/triage/members)
People who help with triaging incoming issues and pull requests. Tag this group if you are unsure which team to tag.
## Mergers
- [@organicmaps/mergers](https://github.com/orgs/organicmaps/teams/mergers/members)
- [@comaps/mergers](https://github.com/orgs/comaps/teams/mergers/members)
People who can merge pull requests that are ready.
## Android
- [@organicmaps/android](https://github.com/orgs/organicmaps/teams/android/members)
- [@comaps/android](https://github.com/orgs/comaps/teams/android/members)
Android experts.
@@ -26,91 +26,91 @@ Android experts.
Android Auto experts (a subteam of Android).
- [@organicmaps/android-auto](https://github.com/orgs/organicmaps/teams/android-auto/members)
- [@comaps/android-auto](https://github.com/orgs/comaps/teams/android-auto/members)
## iOS
- [@organicmaps/ios](https://github.com/orgs/organicmaps/teams/ios/members)
- [@comaps/ios](https://github.com/orgs/comaps/teams/ios/members)
iOS experts.
## Qt
- [@organicmaps/qt](https://github.com/orgs/organicmaps/teams/qt/members)
- [@comaps/qt](https://github.com/orgs/comaps/teams/qt/members)
Qt Desktop & Convergent UI experts.
## C++
- [@organicmaps/cpp](https://github.com/orgs/organicmaps/teams/cpp/members)
- [@comaps/cpp](https://github.com/orgs/comaps/teams/cpp/members)
C++ experts.
## Rendering
- [@organicmaps/rendering](https://github.com/orgs/organicmaps/teams/rendering/members)
- [@comaps/rendering](https://github.com/orgs/comaps/teams/rendering/members)
Rendering experts.
## Data
- [@organicmaps/map](https://github.com/orgs/organicmaps/teams/data/members)
- [#data](https://organicmaps.zulipchat.com/#narrow/channel/477127-Data)
- [@comaps/map](https://github.com/orgs/comaps/teams/data/members)
- [#data](https://comaps.zulipchat.com/#narrow/channel/477127-Data)
Map data generation team.
## Styles
- [@organicmaps/styles](https://github.com/orgs/organicmaps/teams/styles/members)
- [@comaps/styles](https://github.com/orgs/comaps/teams/styles/members)
Map styles team.
## DevOps
- [@organicmaps/devops](https://github.com/orgs/organicmaps/teams/devops/members)
- [@comaps/devops](https://github.com/orgs/comaps/teams/devops/members)
DevOps team.
## Design
- [@organicmaps/design](https://github.com/orgs/organicmaps/teams/design/members)
- [@comaps/design](https://github.com/orgs/comaps/teams/design/members)
Visual design (icons, graphics, colors, contrast, etc.).
## Web
- [@organicmaps/web](https://github.com/orgs/organicmaps/teams/web/members)
- [@comaps/web](https://github.com/orgs/comaps/teams/web/members)
Web development experts.
## Growth
- [@organicmaps/growth](https://github.com/orgs/organicmaps/teams/growth/members)
- [@comaps/growth](https://github.com/orgs/comaps/teams/growth/members)
Marketing, ASO, SEO, and SMM experts.
## Product
- [@organicmaps/product](https://github.com/orgs/organicmaps/teams/product/members)
- [@comaps/product](https://github.com/orgs/comaps/teams/product/members)
Product management group.
## Translations
- [@organicmaps/translations](https://github.com/orgs/organicmaps/teams/translations)
- [@comaps/translations](https://github.com/orgs/comaps/teams/translations)
Internationalization and localization.
Tag [@organicmaps/translations-langcode](https://github.com/orgs/organicmaps/teams/translations/teams) (e.g. @organicmaps/translations-fr) for specific language.
Tag [@comaps/translations-langcode](https://github.com/orgs/comaps/teams/translations/teams) (e.g. @comaps/translations-fr) for specific language.
## Support
- [@organicmaps/support](https://github.com/orgs/organicmaps/teams/support/members)
- [@comaps/support](https://github.com/orgs/comaps/teams/support/members)
End-user support: feedback in stores, emails, user-facing docs (FAQs).
## Legal
- [@organicmaps/legal](https://github.com/orgs/organicmaps/teams/legal/members)
- [@comaps/legal](https://github.com/orgs/comaps/teams/legal/members)
Legal team.

View File

@@ -22,7 +22,7 @@ The project consists of multiple components, each with its own translation files
| Android Stores Descriptions | Google, F-Droid, Huawei store descriptions | [android/app/src/fdroid/play][googleplay_git] ([en][googleplay_git_en]) |
| [Website][website_weblate] | Website content | [organicmaps/website][website_git] ([see details][website_guide]) |
Components without links haven't been integrated into Weblate and must be translated directly via [GitHub Pull Requests](CONTRIBUTING.md).
Components without links haven't been integrated into Weblate and must be translated directly via [Codeberg Pull Requests](CONTRIBUTING.md).
## Translating
@@ -64,13 +64,13 @@ Weblate maintains an internal copy of the Git repository. The repository URL can
Translations are extracted from the repository and stored in an internal database, which is used by the Weblate UI. Every 24 hours, this internal database is synchronized back to the internal repository. This process can also be triggered manually via _Manage → Repository Maintenance → Commit_.
After committing changes from the internal database to the internal repository, Weblate pushes all updates to the `weblate-i18n` branch of the main GitHub repository and creates or updates a pull request (PR) to `master`. This operation can be manually triggered via _Manage → Repository Maintenance → Push_.
After committing changes from the internal database to the internal repository, Weblate pushes all updates to the `weblate-i18n` branch of the main Codeberg repository and creates or updates a pull request (PR) to `master`. This operation can be manually triggered via _Manage → Repository Maintenance → Push_.
### Reviewing PRs
Translations are intended to be reviewed by the community on Weblate. However, if it's a user's first contribution or if there is any doubt, a quick scan and comparison with the English source can be useful.
It is recommended to add comments directly on Weblate, as translators primarily work within that platform. If the contributor has a GitHub account, you may tag them in the pull request, but there is no guarantee that they will respond.
It is recommended to add comments directly on Weblate, as translators primarily work within that platform. If the contributor has a Codeberg account, you may tag them in the pull request, but there is no guarantee that they will respond.
### Resolving Conflicts
@@ -78,11 +78,11 @@ The recommended approach for resolving conflicts is as follows:
1. Commit all changes from the internal database to the internal Git repository:
_Manage → Repository Maintenance → Commit (button)_.
2. Update the `weblate-i18n` branch on GitHub:
2. Update the `weblate-i18n` branch on Codeberg:
_Manage → Repository Maintenance → Push (button)_.
3. Locally checkout the `weblate-i18n` branch.
4. Rebase it onto `master`, resolving any conflicts during the process.
5. Push the branch to GitHub to update the pull request, then merge the branch or PR into `master`.
5. Push the branch to Codeberg to update the pull request, then merge the branch or PR into `master`.
6. Reset Weblate to sync changes from GitHub:
_Manage → Repository Maintenance → Reset (button)_.

View File

@@ -502,9 +502,9 @@ def get_requirements(path="", omim_package_version=get_version()):
def setup_omim_pybinding(
name,
version=None,
author='Organic Maps',
author_email='info@organicmaps.app',
url='https://github.com/organicmaps/organicmaps',
author='CoMaps',
author_email='info@comaps.app',
url='https://codeberg.com/comaps/comaps',
license='Apache-2.0',
supported_pythons=('2', '2.7', '3', '3.5', '3.6', '3.7', '3.8', '3.9'),
):

View File

@@ -32,7 +32,7 @@ License: Apache Public License 2.0
Vendor: Mail.Ru Group
Group: Development/Languages/Python
URL: https://github.com/organicmaps/organicmaps
URL: https://codeberg.com/comaps/comaps
Source: omim-py-modules-%{version}.tar.gz
BuildRoot: %{_tmppath}/%{name}-%{version}-%{release}-buildroot
@@ -63,7 +63,7 @@ if [ -e %{S:0} ]; then
%{__tar} xzf %{S:0}
%{__chmod} -Rf a+rX,u+w,g-w,o-w %{_builddir}/%{name}-%{version}
else
git clone --depth=1 https://github.com/organicmaps/organicmaps.git %{_builddir}/%{name}-%{version}/omim
git clone --depth=1 https://codeberg.com/comaps/comaps.git %{_builddir}/%{name}-%{version}/omim
pushd %{_builddir}/%{name}-%{version}/omim
git fetch origin tag %{tag} --depth=1
git checkout %{tag}

View File

@@ -3,7 +3,7 @@ This document describes how to use the tools for search quality analysis.
1. Prerequisites.
* Get the latest version of the project (https://github.com/organicmaps/organicmaps) and build it.
* Get the latest version of the project (https://codeberg.com/comaps/comaps) and build it.
* Get the latest samples.lisp file with search queries. If you don't know
how to get it, please, contact the search team.