Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 35 additions & 0 deletions guides/faq.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Frequently Asked Questions (FAQ)

## How do I release and distribute my Desktop application?

### Creating an Installer

To create a distributable installer for your Desktop application, use the following command:

```bash
mix desktop.installer
```

This command will create platform-specific installers for Windows, macOS, and Linux that you can distribute to your users.

### About `mix release`

While `mix release` is a standard Elixir command for creating releases, it's not the recommended approach for Desktop applications. The `mix release` command creates a standalone Erlang release, but it doesn't include the platform-specific packaging and UI components needed for a Desktop application.

### Distribution

After running `mix desktop.installer`, you'll find the installer files in your project's build directory. These are the files you should distribute to your users:

- **Windows**: `.exe` installer file
- **macOS**: `.dmg` or `.app` bundle
- **Linux**: `.AppImage`, `.deb`, or `.rpm` package

Users can simply download and run these installers to install your application on their system.

### Getting Started

If you're new to Elixir Desktop:

1. Follow the [Getting your Environment Ready Guide](getting_started.md) to set up your development environment
2. Create your first app with the [Your first Desktop App Guide](your_first_desktop_app.md)
3. When ready to distribute, run `mix desktop.installer` to create platform-specific installers
3 changes: 2 additions & 1 deletion mix.exs
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,8 @@ defmodule Desktop.MixProject do
"README.md": [title: "Overview"],
"CHANGELOG.md": [title: "Changelog"],
"guides/getting_started.md": [title: "Getting your Environment Ready"],
"guides/your_first_desktop_app.md": [title: "Your first Desktop App"]
"guides/your_first_desktop_app.md": [title: "Your first Desktop App"],
"guides/faq.md": [title: "FAQ"]
],
main: "readme",
source_ref: "v#{@version}",
Expand Down