Skip to content

Commit

Permalink
Add workflow and fix docs (#2)
Browse files Browse the repository at this point in the history
  • Loading branch information
JustinTimperio authored Dec 15, 2024
1 parent 3a2fbe3 commit 38e3cd5
Show file tree
Hide file tree
Showing 3 changed files with 53 additions and 5 deletions.
38 changes: 38 additions & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
name: Build Release

on:
push:
branches:
- "master"
tags:
- "v*" # For v1.0, v0.1.0, etc
pull_request:
branches:
- "master"

jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4

- name: Build
run: |
sudo apt update -y
sudo apt install -y docker golang git
go install github.com/fyne-io/fyne-cross@latest
~/go/bin/fyne-cross linux -arch=amd64,arm64 -app-id="OnionSoup"
~/go/bin/fyne-cross windows -arch=amd64,arm64 -app-id="Onion.Soup"
- name: Release
uses: softprops/action-gh-release@v2
if: startsWith(github.ref, 'refs/tags/')
with:
files: |
LICENSE
fyne-cross/dist/linux-amd64/onionsoup.tar.xz
fyne-cross/dist/linux-arm64/onionsoup.tar.xz
fyne-cross/dist/windows-amd64/onionsoup.exe.zip
fyne-cross/dist/windows-arm64/onionsoup.exe.zip
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
.history/
fyne-cross/
tests/
macos-sdk/
19 changes: 14 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,22 +27,31 @@ This example highlights how 2 parties (Alice and Bob), can bootstrap a conversat
5. The session will remain open until either party closes their session, which will terminate the conversation.

## Installation
TODO: Add instructions for installing the prebuilt binaries
Prebuilt Application Installers will be included in the Release section of this repo but currently some errors are being resolved in the build pipeline. See [this issue](https://github.com/JustinTimperio/onionsoup/issues/2)

## Building from Source

To bundle the assets into the program run:
```bash
~/go/bin/fyne bundle -package data -o data/bundle.go data/assets
~/go/bin/fyne bundle -package data -o data/bundled.go data/assets
```

To build a release version use the following:
### Linux
```bash
~/go/bin/fyne-cross windows -arch=amd64,arm64 -app-id="OnionSoup"
~/go/bin/fyne-cross darwin -arch=amd64,arm64 -app-id="OnionSoup"
~/go/bin/fyne-cross linux -arch=amd64,arm64 -app-id="OnionSoup"
```

### Windows
```bash
~/go/bin/fyne-cross windows -arch=amd64,arm64 -app-id="Onion.Soup"
```

### Mac
*Mac Builds are currently not working, please see [this issue](https://github.com/JustinTimperio/onionsoup/issues/1)*
```bash
~/go/bin/fyne-cross darwin -arch=amd64,arm64 -app-id="Onion.Soup" --macosx-sdk-path /full-path/macos-sdk/MacOSX15.2.sdk
```


## Design

Expand Down

0 comments on commit 38e3cd5

Please sign in to comment.