Skip to content

164 housekeeping update readme - #172

Merged
hizclick merged 4 commits into
mainfrom
164-housekeeping-update-readme
Aug 5, 2026
Merged

164 housekeeping update readme#172
hizclick merged 4 commits into
mainfrom
164-housekeeping-update-readme

Conversation

@hizclick

@hizclick hizclick commented Aug 5, 2026

Copy link
Copy Markdown
Collaborator

Summary

This PR adds documentation for distributing Cartographer App as a native application using Tauri.

Changes

  • Added prerequisites for Tauri desktop and Android development.
  • Documented how to run the native application in development mode.
  • Documented how to create desktop distribution packages.
  • Clarified that desktop packages must be built on their target operating system.
  • Added macOS-specific guidance for building without DMG creation.
  • Documented Android SDK, NDK, JDK, and Rust target requirements.
  • Added instructions for generating an Android APK.
  • Documented Android APK signing requirements.
  • Added guidance for securely storing and backing up the Android signing key.
  • Documented the use of Rustls for Android-compatible TLS.
  • Explained GitHub authentication through the Device Flow in native builds.
  • Documented the required GitHub OAuth App and client ID configuration.

Motivation

Cartographer App can now be distributed as a native desktop or Android application through Tauri. This documentation provides contributors and maintainers with the information required to develop, build, authenticate, sign, and distribute these native packages.

Validation

  • Review the documented Tauri prerequisites.
  • Run npm run tauri:dev.
  • Run npm run tauri:build on a supported desktop platform.
  • Verify the documented macOS build option.
  • Build the Android APK using the documented command.
  • Verify the Android APK signing instructions.
  • Verify GitHub Device Flow authentication in a native build.
  • Run npm run docs:build.

hizclick added 4 commits July 29, 2026 14:37
# Please enter a commit message to explain why this merge is necessary,
# especially if it merges an updated upstream into a topic branch.
#
# Lines starting with '#' will be ignored, and an empty message aborts
# the commit.
@hizclick
hizclick merged commit 52ea0d9 into main Aug 5, 2026
@hizclick
hizclick deleted the 164-housekeeping-update-readme branch August 5, 2026 09:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant