Skip to content

Commit 6990043

Browse files
Copilotdominicletz
andcommitted
Add FAQ guide for releasing and distributing Desktop applications
Co-authored-by: dominicletz <2987674+dominicletz@users.noreply.github.com>
1 parent cb2c312 commit 6990043

2 files changed

Lines changed: 37 additions & 1 deletion

File tree

guides/faq.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Frequently Asked Questions (FAQ)
2+
3+
## How do I release and distribute my Desktop application?
4+
5+
### Creating an Installer
6+
7+
To create a distributable installer for your Desktop application, use the following command:
8+
9+
```bash
10+
mix desktop.installer
11+
```
12+
13+
This command will create platform-specific installers for Windows, macOS, and Linux that you can distribute to your users.
14+
15+
### About `mix release`
16+
17+
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.
18+
19+
### Distribution
20+
21+
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:
22+
23+
- **Windows**: `.exe` installer file
24+
- **macOS**: `.dmg` or `.app` bundle
25+
- **Linux**: `.AppImage`, `.deb`, or `.rpm` package
26+
27+
Users can simply download and run these installers to install your application on their system.
28+
29+
### Getting Started
30+
31+
If you're new to Elixir Desktop:
32+
33+
1. Follow the [Getting your Environment Ready Guide](getting_started.md) to set up your development environment
34+
2. Create your first app with the [Your first Desktop App Guide](your_first_desktop_app.md)
35+
3. When ready to distribute, run `mix desktop.installer` to create platform-specific installers

mix.exs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,8 @@ defmodule Desktop.MixProject do
105105
"README.md": [title: "Overview"],
106106
"CHANGELOG.md": [title: "Changelog"],
107107
"guides/getting_started.md": [title: "Getting your Environment Ready"],
108-
"guides/your_first_desktop_app.md": [title: "Your first Desktop App"]
108+
"guides/your_first_desktop_app.md": [title: "Your first Desktop App"],
109+
"guides/faq.md": [title: "FAQ"]
109110
],
110111
main: "readme",
111112
source_ref: "v#{@version}",

0 commit comments

Comments
 (0)