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 09ec4fa..cbc0588 100644 --- a/README.md +++ b/README.md @@ -2,38 +2,14 @@ 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) - -## 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 @@ -48,9 +24,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")