Description

The Description section of the README.md file contains the description of this app as it will appear in catalog browser applications.

It supports basic formatting, but not images, lists, or links.

Installation

App Fair Installation

This app can be installed with the App Fair.app by launching: appfair://app/App-Name

Homebrew Installation

Homebrew users on macOS can alternatively install this app directly with the command:

$ brew install appfair/app/app-name

The app will be installed in the /Applications/App Fair/ folder. It can be un-installed by dragging it to the Trash.

Support

Community Support for this app is available from its Discussion forums.

Issue reports and suggestions for improvement are available from the Issues page.

License

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published
by the Free Software Foundation.

Development

This project contains the base of an App Fair app, which is an application distribution platform for native SwiftUI applications.

Fork this project into an organization name App Name to use as the basis for your own app, then submit a PR to have it automatically built and distributed through the App Fair catalog.

To get started building your own app using only your web browser:

1. Create a new GitHub Organization. The organization's name will uniquely identify your app and should consist of two short words (no numbers) separated by a single hyphen. For example: App-Name.
2. Set the public e-mail in the Organization settings to be to same as your GitHub e-mail address.
3. Fork the appfair/App repository into your new App-Name organization. The fork must reside in an organization rather than your personal account.
4. Open the App fork's About panel and set the description to be a brief (< 80 character) single-sentence summary of your application, then add a single topic starting with "appfair-", such as appfair-utilities.
5. Update your App fork's settings to enable Issues and Discussions.
6. Edit AppFairApp.xcconfig and update PRODUCT_NAME to be App Name (the app name with a space) and PRODUCT_BUNDLE_IDENTIFIER to be app.App-Name.
7. Edit this README.md file to describe and document your app. The #Description section will be published as part of your App's catalog information.
8. Edit Sources/App/AppContainer.swift and add some SwiftUI code to the ContentView.body.
9. Enable actions for the App fork, which will be used to validate the App settings, as well as build and publish releases.
10. Create a new 0.0.1 release for the main branch. The release tag must match the MARKETING_VERSION key in the AppFairApp.xcconfig file. Release notes can be entered into the description field. Specify "pre-release" and hit the Publish release button.
11. Wait for the release action to complete successfully, then verify that the release artifacts are available on the releases page.
12. Create a Pull Request (PR) to the the base /appfair/App/ repository with the title: app.App-Name (matching the PRODUCT_BUNDLE_IDENTIFIER in the AppFairApp.xcconfig file).
13. Submit the PR and monitor the status of its check actions, which will validate the app release and update the App Fair catalog. The PR will be closed automatically once it has completed.

Your release build will shortly become available in the App Fair catalog browser application (with the "Pre-release" preference enabled), as well as automatically published to the homebrew catalog, from where it can be installed with the terminal command:

$ brew install appfair/app/app-name-prerelease

Download, share and enjoy!