Update Flatpak manifest and instructions
This commit is contained in:
david-swift
parent
7fc6f7b5fc
commit
447a06e5cb
52
README.md
52
README.md
|
|
@ -3,7 +3,7 @@
|
|||
<h1 align="center">Adwaita Template</h1>
|
||||
</p>
|
||||
|
||||
_Adwaita Template_ is a template application for the [Adwaita package](https://github.com/AparokshaUI/Adwaita/).
|
||||
_Adwaita Template_ is a template application for the [Adwaita for Swift package](https://github.com/AparokshaUI/Adwaita/).
|
||||
|
||||
## Table of Contents
|
||||
|
||||
|
|
@ -13,48 +13,14 @@ _Adwaita Template_ is a template application for the [Adwaita package](https://g
|
|||
|
||||
## Installation
|
||||
|
||||
### Install the Swift 5 Freedesktop SDK Extension
|
||||
Install the [GNOME Builder](https://flathub.org/apps/org.gnome.Builder) IDE.
|
||||
|
||||
1. Install `flatpak`.
|
||||
2. Add Flathub to Flatpak:
|
||||
```
|
||||
flatpak remote-add --if-not-exists flathub https://flathub.org/repo/flathub.flatpakrepo
|
||||
```
|
||||
3. Install the newest version of the Freedesktop SDK:
|
||||
```
|
||||
flatpak install flathub org.freedesktop.Sdk
|
||||
```
|
||||
4. Install the LLVM 16 Freedesktop extension:
|
||||
```
|
||||
flatpak install flathub org.freedesktop.Sdk.Extension.llvm16/x86_64/23.08
|
||||
```
|
||||
5. Install the GNOME SDK. It's not required for building the Swift Freedesktop SDK extension, but later for building the application:
|
||||
```
|
||||
flatpak install flathub org.gnome.Sdk
|
||||
```
|
||||
6. Install the Swift 5 Freedesktop SDK Extension.
|
||||
```
|
||||
flatpak install flathub org.freedesktop.Sdk.Extension.swift5
|
||||
```
|
||||
|
||||
### Install Other Tools
|
||||
|
||||
The following tools are required or recommended for editing this repository:
|
||||
- [GNOME Builder](https://flathub.org/apps/org.gnome.Builder)
|
||||
- [App Icon Preview](https://flathub.org/apps/org.gnome.design.AppIconPreview)
|
||||
- [Inkscape](https://flathub.org/apps/org.inkscape.Inkscape)
|
||||
For designing an app icon, [App Icon Preview](https://flathub.org/apps/org.gnome.design.AppIconPreview) and [Inkscape](https://flathub.org/apps/org.inkscape.Inkscape) are recommended.
|
||||
|
||||
## Usage
|
||||
|
||||
1. Open this project in GNOME Builder. Copy the path to the containing folder of this file (in the sidebar) and replace the following piece of text in the `io.github.AparokshaUI.AdwaitaTemplate.json` file:
|
||||
```
|
||||
https://github.com/AparokshaUI/AdwaitaTemplate
|
||||
```
|
||||
with the following syntax (replace `/path/to/directoy`):
|
||||
```
|
||||
file:///path/to/directory
|
||||
```
|
||||
2. Build and run the application.
|
||||
1. Open this project in the GNOME Builder. It will start downloading the dependencies.
|
||||
2. Build and run the application using the "run" icon in the toolbar.
|
||||
3. Change the app's name and other information about the application in the following files (and file names):
|
||||
- `README.md`
|
||||
- `Package.swift`
|
||||
|
|
@ -66,16 +32,16 @@ file:///path/to/directory
|
|||
- `data/icons/io.github.AparokshaUI.AdwaitaTemplate.svg`
|
||||
- `data/icons/io.github.AparokshaUI.AdwaitaTemplate-symbolic.svg`
|
||||
4. Edit the code. Help is available [here](https://david-swift.gitbook.io/adwaita/), ask questions in the [discussions](https://github.com/AparokshaUI/Adwaita/discussions/).
|
||||
5. Edit the app's icons using the previously installed tools according to [this](https://blogs.gnome.org/tbernard/2019/12/30/designing-an-icon-for-your-app/) tutorial.
|
||||
6. In GNOME Builder, click on the dropdown next to the hammer and then on `Export`. Wait until the file explorer appears, open the `.flatpak` file and install the app on your device!
|
||||
5. You can edit the app's icons using the previously installed tools according to [this](https://blogs.gnome.org/tbernard/2019/12/30/designing-an-icon-for-your-app/) 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!
|
||||
|
||||
### Flatpak SPM Generator
|
||||
|
||||
If you want to e.g. publish your app on Flathub and there is no internet connection allowed while running the build commands,
|
||||
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](https://github.com/flatpak/flatpak-builder-tools/tree/master/spm) that lets you generate a Flatpak manifest JSON from a Swift package.
|
||||
|
||||
## Thanks
|
||||
|
||||
### Dependencies
|
||||
- [Adwaita](https://github.com/AparokshaUI/Adwaita) licensed under the [MIT License](https://github.com/AparokshaUI/Adwaita/blob/main/LICENSE.md)
|
||||
- [Adwaita for Swift](https://github.com/AparokshaUI/Adwaita) licensed under the [MIT License](https://github.com/AparokshaUI/Adwaita/blob/main/LICENSE.md)
|
||||
- [Localized](https://github.com/AparokshaUI/Localized) licensed under the [MIT License](https://github.com/AparokshaUI/Localized/blob/master/LICENSE.md)
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
{
|
||||
"app-id": "io.github.AparokshaUI.AdwaitaTemplate",
|
||||
"runtime": "org.gnome.Platform",
|
||||
"runtime-version": "45",
|
||||
"runtime-version": "46",
|
||||
"sdk": "org.gnome.Sdk",
|
||||
"sdk-extensions": [
|
||||
"org.freedesktop.Sdk.Extension.swift5"
|
||||
|
|
@ -35,9 +35,8 @@
|
|||
"buildsystem": "simple",
|
||||
"sources": [
|
||||
{
|
||||
"type": "git",
|
||||
"url": "https://github.com/AparokshaUI/AdwaitaTemplate",
|
||||
"branch": "main"
|
||||
"type": "dir",
|
||||
"path": "."
|
||||
}
|
||||
],
|
||||
"build-commands": [
|
||||
|
|
|
|||
Loading…
Reference in New Issue