Skip to content

Briefcase

Write documentation

Initializing search

Tutorial
How-to guides
Topic guides
Reference
About Briefcase

Briefcase

Tutorial
How-to guides
How-to guides
- Obtaining a Code Signing identity
  Obtaining a Code Signing identity
  - Android
  - macOS
  - Windows
- Building different types of apps
  Building different types of apps
- Testing apps
  Testing apps
  - Testing Linux Apps with Docker
- Debugging apps
  Debugging apps
  - Debug via PDB
  - Debug via VS Code
- Publishing your app
  Publishing your app
  - Android
  - iOS
  - macOS
- Contributing to Briefcase
  Contributing to Briefcase
  - First-time contributors
  - What can I do?
    What can I do?
    
    Fix an issue
    
    Implement a new feature
    
    Write documentation
    
    Triage an issue
    
    Review a pull request
    
    Propose a new feature
    
    Use the tools
  - How do I contribute?
    How do I contribute?
    
    Setting up a development environment
    
    Reproducing an issue
    
    Working from a branch
    
    Avoiding scope creep
    
    Writing, running, and testing code
    
    Building documentation
    
    Writing documentation
    
    Adding a change note
    
    Submitting a pull request
    
    Providing a review
    
    Submitting a new issue
    
    Proposing a new feature
  - What happens next?
    What happens next?
    
    Pull request review process
    
    Release process
  - Style guides
    Style guides
    
    Code style guide
    
    Documentation style guide
- Internal How-to guides
  Internal How-to guides
  - How to cut a Briefcase release
- Upgrading from previous versions
  Upgrading from previous versions
  - Upgrading from Briefcase v0.2
Topic guides
Topic guides
- Accessing Briefcase packaging metadata at runtime
Reference
Reference
- Briefcase configuration options
- Project configuration options
- Command Reference
  Command Reference
  - new
  - convert
  - dev
  - create
  - build
  - update
  - run
  - package
  - publish
  - upgrade
- Platform support
  Platform support
  - macOS
    
    macOS
    
    .app bundle
    
    macOS Xcode project
  - Windows
    
    Windows
    
    Windows App folder
    
    Visual Studio project
  - Linux
    Linux
    
    Native System Packages
    
    Flatpak
    
    AppImage
  - iOS
    iOS
    
    iOS Xcode project
  - Android
    Android
    
    Gradle project
  - Web
    Web
    
    Static Web
- Plugins
About Briefcase
About Briefcase

Adding documentation¶