From dbe78e061e1765fcc3d34b096f867816d9980005 Mon Sep 17 00:00:00 2001 From: Adam Wight Date: Mon, 16 Dec 2024 21:59:56 +0100 Subject: [PATCH 1/4] Escape underscore character This seems to confuse most markdown parsers, so escape it. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 09ec4fa..b57f655 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ mix desktop.installer ## Changes in 1.0 -- Updated to Phoenix 1.6 with esbuild+dart_scss +- Updated to Phoenix 1.6 with esbuild+dart\_scss - Added iOS platform example wrapper (see https://github.com/elixir-desktop/ios-example-app) - Added Android platform example wrapper (see https://github.com/elixir-desktop/android-example-app) From d34d3ba13f8c1140b7618a2cb703b2743bdcf21d Mon Sep 17 00:00:00 2001 From: Adam Wight Date: Mon, 16 Dec 2024 22:02:07 +0100 Subject: [PATCH 2/4] Consolidate dependency documentation "general notes" were redundant with the listed dependencies in the next section. --- README.md | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index b57f655..eed8527 100644 --- a/README.md +++ b/README.md @@ -22,18 +22,14 @@ mix desktop.installer - Added iOS platform example wrapper (see https://github.com/elixir-desktop/ios-example-app) - Added Android platform example wrapper (see https://github.com/elixir-desktop/android-example-app) -## General notes - -To run this app you need at least Erlang 24 and recent builds of wxWidgets and at least -Elixir 1.11.4. - ## Dependencies This example assumes you've got installed: - git -- Elixir, at least 1.11.4 +- Elixir, at least 1.14 - Erlang, at least OTP 24 +- wxWidgets - npm - C compiler (make/nmake) for SQLite From 291360c2393bf7ff83798a7719155d382ec8f2eb Mon Sep 17 00:00:00 2001 From: Adam Wight Date: Mon, 16 Dec 2024 22:02:48 +0100 Subject: [PATCH 3/4] Add more quickstart steps MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit I needed to add some steps locally—may or may not be correct for others! --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index eed8527..301641a 100644 --- a/README.md +++ b/README.md @@ -44,9 +44,16 @@ Run: cd assets npm install cd .. +mix deps.get mix assets.deploy ``` +To build binaries locally run: + +```bash +mix desktop.installer +``` + ## Screenshots ![Linux build](/nodeploy/linux_todo.png?raw=true "Linux build") From 1d33134f130b8c18a2854e83ec544113f4872ac6 Mon Sep 17 00:00:00 2001 From: Adam Wight Date: Mon, 16 Dec 2024 22:03:31 +0100 Subject: [PATCH 4/4] Split changelog into its own file --- CHANGELOG.md | 24 ++++++++++++++++++++++++ README.md | 20 -------------------- 2 files changed, 24 insertions(+), 20 deletions(-) create mode 100644 CHANGELOG.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..1e1e883 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,24 @@ +# Changelog for example project + +## [1.2] + +### Added + +- Added `desktop_deployment` and CI to generate windows+macos+linux binaries + +## [1.1] + +### Changed + +- Updated to Phoenix 1.7 and LiveView 0.18 + +## [1.0] + +### Added + +- Added iOS platform example wrapper (see https://github.com/elixir-desktop/ios-example-app) +- Added Android platform example wrapper (see https://github.com/elixir-desktop/android-example-app) + +### Changed + +- Updated to Phoenix 1.6 with esbuild+dart\_scss diff --git a/README.md b/README.md index 301641a..cbc0588 100644 --- a/README.md +++ b/README.md @@ -2,26 +2,6 @@ This application is an example of an Elixir LiveView based desktop application. It uses the elixir-desktop library and a local SQLite database to create a web-technology based desktop app. -## Changes in 1.2 - -- Added `desktop_deployment` and CI to generate windows+macos+linux binaries - -To build binaries locally run: - -```bash -mix desktop.installer -``` - -## Changes in 1.1 - -- Updated to Phoenix 1.7 and LiveView 0.18 - -## Changes in 1.0 - -- Updated to Phoenix 1.6 with esbuild+dart\_scss -- Added iOS platform example wrapper (see https://github.com/elixir-desktop/ios-example-app) -- Added Android platform example wrapper (see https://github.com/elixir-desktop/android-example-app) - ## Dependencies This example assumes you've got installed: