aparoksha/adwaita-template
Template
1
1
Fork 0
Code Issues 2 Pull Requests Activity
A template application repository for the Adwaita for Swift framework
31 Commits 1 Branch 0 Tags 106 KiB
Swift 93.4%
Dockerfile 6.6%
main
Go to file Use this template
david-swift 8811c923f4 Update to latest Meta changes
2024-10-08 12:35:29 +02:00
.devcontainer Fix dockerfile 2024-06-14 00:06:01 -07:00
data Add Flatpak CI 2024-08-27 07:04:05 +02:00
Sources Update to latest Meta changes 2024-10-08 12:35:29 +02:00
.gitignore First pass at vscode 2024-06-13 01:38:09 -07:00
io.github.AparokshaUI.AdwaitaTemplate.json Migrate to the Aparoksha Gitea instance 2024-10-07 17:05:31 +02:00
LICENSE.md Initial Commit 2023-11-26 22:19:52 +01:00
Package.swift Migrate to the Aparoksha Gitea instance 2024-10-07 17:05:31 +02:00
README.md Migrate to the Aparoksha Gitea instance 2024-10-07 17:05:31 +02:00

README.md

Adwaita Template Icon

Adwaita Template

Adwaita Template is a template application for the Adwaita for Swift package.

Table of Contents

Installation

Install the GNOME Builder IDE.

For designing an app icon, App Icon Preview and Inkscape are recommended.

Note

You do not have to install any dependencies of Adwaita for Swift, including Swift, on your system. The Adwaita template runs in a Flatpak. The GNOME Builder will automatically download dependencies from Flathub. You can also use Visual Studio Code with a Docker dev container hosting the Swift toolchain and Adwaita libraries.

Usage

  1. Open this project in the GNOME Builder. It will start downloading the dependencies.
  2. Build and run the application.
    • For GNOME Builder, use the "run" icon in the toolbar.
    • For Visual Studio Code, select the "run and debug" tab in the leftmost sidebar, and then tap the run icon next to "Debug AdwaitaTemplate".
  3. Change the app's name and other information about the application in the following files (and file names):
    • README.md
    • Package.swift
    • io.github.AparokshaUI.AdwaitaTemplate.json
    • Sources/AdwaitaTemplate.swift
    • data/io.github.AparokshaUI.AdwaitaTemplate.metainfo.xml
    • data/io.github.AparokshaUI.AdwaitaTemplate.desktop
    • data/icons/io.github.AparokshaUI.AdwaitaTemplate.Source.svg
    • data/icons/io.github.AparokshaUI.AdwaitaTemplate.svg
    • data/icons/io.github.AparokshaUI.AdwaitaTemplate-symbolic.svg
  4. Edit the code. Help is available here, ask questions in the forums.
  5. You can edit the app's icons using the previously installed tools according to this tutorial.
  6. In GNOME Builder, click on the dropdown next to the hammer and then on Export. Wait until the file manager appears, open the .flatpak file and install the app on your device!
  7. If you want to publish your app, replace debug in the following build commands by release:
"swift build -c debug --static-swift-stdlib",
"install -Dm755 .build/debug/AdwaitaTemplate /app/bin/AdwaitaTemplate",

Flatpak SPM Generator

If you want to e.g. publish your app on Flathub where no internet connection is allowed while running the build commands, you can use this tool that lets you generate a Flatpak manifest JSON from a Swift package.

Thanks

Dependencies