Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
adam-ce authored Nov 27, 2023
1 parent 839362f commit c5ed0d0
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,21 +10,21 @@ https://discord.gg/p8T9XzVwRa
After that it should be a normal cmake project. That is, you run cmake to generate a project or build file and then run your favourite tool. All dependencies should be pulled automatically into `renderer/external` while you run CMake.
We use Qt Creator (with mingw on Windows), which is the only tested setup atm and makes setup of Android and WebAssembly builds reasonably easy. If you have questions, please open a new [discussion](https://github.com/AlpineMapsOrg/renderer/discussions).

## Dependencies for the native and android build
* Qt 6.5.0, or greater
## Dependencies
* Qt 6.6.0, or greater
* OpenGL
* Qt Positioning and qt5 compatibility modules
* Qt Positioning and Charts modules
* Some other dependencies will be pulled automatically during building.

## Building the android version
* Due to a [bug](https://bugreports.qt.io/browse/QTBUG-113851) in the Qt/cmake/gradle build system for android, you need to delete all `libc.so` files from the build dir before rebuilding (yes! no, that's not a joke). There is a script that does that in linux [renderer/android/workaround_qt_cmake_build_bug.sh](https://github.com/AlpineMapsOrg/renderer/blob/main/android/workaround_qt_cmake_build_bug.sh), please don't run it anywhere important, definitely not as root;) ). You can add it as a custom build step before everything else in qt creator (in the %{buildDir} working directory).

## Building the WebAssembly version:
* Atm, none of the Qt versions works perfectly in all browsers
* In Qt 6.5.0 there is no search
* In Qt 6.5.1 touch doesn't work on Firefox, and the Keyboard doesn't work on touch notebooks (issues #33, #34)
* In Qt 6.6 touch doesn't work on Firefox (issues #33)
* [WebAssembly version compatible with the Qt version](https://doc-snapshots.qt.io/qt6-dev/wasm.html#installing-emscripten)
* The threaded version doesn't seem to work atm, so use the non-threaded!
* There are a number of other bugs, we track them with the upstream tag.

# Code style
* class names are CamelCase, method, function and variable names are snake_case.
Expand Down

0 comments on commit c5ed0d0

Please sign in to comment.