Skip to content

Commit 82d5a8c

Browse files
authored
Minor doc updates; split out changelog (#24)
* Escape underscore character This seems to confuse most markdown parsers, so escape it. * Consolidate dependency documentation "general notes" were redundant with the listed dependencies in the next section. * Add more quickstart steps I needed to add some steps locally—may or may not be correct for others! * Split changelog into its own file
1 parent 0db3272 commit 82d5a8c

2 files changed

Lines changed: 33 additions & 26 deletions

File tree

CHANGELOG.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Changelog for example project
2+
3+
## [1.2]
4+
5+
### Added
6+
7+
- Added `desktop_deployment` and CI to generate windows+macos+linux binaries
8+
9+
## [1.1]
10+
11+
### Changed
12+
13+
- Updated to Phoenix 1.7 and LiveView 0.18
14+
15+
## [1.0]
16+
17+
### Added
18+
19+
- Added iOS platform example wrapper (see https://github.com/elixir-desktop/ios-example-app)
20+
- Added Android platform example wrapper (see https://github.com/elixir-desktop/android-example-app)
21+
22+
### Changed
23+
24+
- Updated to Phoenix 1.6 with esbuild+dart\_scss

README.md

Lines changed: 9 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -2,38 +2,14 @@
22

33
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.
44

5-
## Changes in 1.2
6-
7-
- Added `desktop_deployment` and CI to generate windows+macos+linux binaries
8-
9-
To build binaries locally run:
10-
11-
```bash
12-
mix desktop.installer
13-
```
14-
15-
## Changes in 1.1
16-
17-
- Updated to Phoenix 1.7 and LiveView 0.18
18-
19-
## Changes in 1.0
20-
21-
- Updated to Phoenix 1.6 with esbuild+dart_scss
22-
- Added iOS platform example wrapper (see https://github.com/elixir-desktop/ios-example-app)
23-
- Added Android platform example wrapper (see https://github.com/elixir-desktop/android-example-app)
24-
25-
## General notes
26-
27-
To run this app you need at least Erlang 24 and recent builds of wxWidgets and at least
28-
Elixir 1.11.4.
29-
305
## Dependencies
316

327
This example assumes you've got installed:
338

349
- git
35-
- Elixir, at least 1.11.4
10+
- Elixir, at least 1.14
3611
- Erlang, at least OTP 24
12+
- wxWidgets
3713
- npm
3814
- C compiler (make/nmake) for SQLite
3915

@@ -48,9 +24,16 @@ Run:
4824
cd assets
4925
npm install
5026
cd ..
27+
mix deps.get
5128
mix assets.deploy
5229
```
5330

31+
To build binaries locally run:
32+
33+
```bash
34+
mix desktop.installer
35+
```
36+
5437
## Screenshots
5538

5639
![Linux build](/nodeploy/linux_todo.png?raw=true "Linux build")

0 commit comments

Comments
 (0)