8

GitHub - hexedbits/AboutThisApp: A standard "About This App" view for...

 4 years ago
source link: https://github.com/hexedbits/AboutThisApp
Go to the source link to view the article. You can view the picture content, updated content and better typesetting reading experience. If the link is broken, please click the button below to view the snapshot at that time.

README.md

AboutThisApp

Actions Status

A standard "About This App" view for any Mac app

About

This library provides a standard "About This App" view for Mac apps. It requires zero configuration by default for typical projects, but it can also be easily customized.

AppKit provides a default "About This App" view for regular windowed applications, but you cannot customize it. It is also inaccessible for apps that live only in the menu bar.

This component is used in Red Eye and Lucifer.

screenshot_dark.png

screenshot_light.png

Usage

let metadata = AppMetadata() // customize if desired

let panel = AboutThisAppPanel(metadata: metadata)

panel.makeKeyAndOrderFront(nil)

Requirements

  • macOS 10.14+
  • Swift 5+
  • Xcode 11+
  • SwiftLint

Installation

Swift Package Manager

Add AboutThisApp to the dependencies value of your Package.swift.

dependencies: [
    .package(url: "https://github.com/hexedbits/AboutThisApp", from: "1.0.0")
]

Alternatively, you can add the package directly via Xcode.

Documentation

Read the docs. Generated with jazzy. Hosted by GitHub Pages.

Generate

$ ./scripts/build_docs.sh

Preview

$ open index.html -a Safari

Contributing

Interested in making contributions to this project? Please review the guides below.

Also, consider sponsoring this project or buying my apps! ✌️

Credits

Created and maintained by @jesse_squires.

License

Released under the MIT License. See LICENSE for details.

Copyright © 2020-present Jesse Squires.


report

Recommend

About Joyk


Aggregate valuable and interesting links.
Joyk means Joy of geeK