Skip to content

Commit

Permalink
refactor(docs): Change workflow requirements to a list view
Browse files Browse the repository at this point in the history
  • Loading branch information
harrtho committed Jan 10, 2023
1 parent 656fa79 commit 9d3d34c
Showing 1 changed file with 17 additions and 4 deletions.
21 changes: 17 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Alfred Battery

[![GitHub Version][version-shield]][releases]
[![GitHub All Releases][downloads-shield]][releases]
[![GitHub][licence-shield]][mit-licence]

Display battery information of your Apple laptop in Alfred

![][demo]
Expand All @@ -15,24 +19,33 @@ Alfred Battery shows:

Alfred Battery uses a [built-in Swift][built-in-swift] program to retrieve the battery information from the system.

## Dependencies
## Requirements

The Alfred Battery workflow depends on a [python3.7+][python] installation. Install `python3` e.g. via. [Homebrew][homebrew] `brew install python`.
- [Alfred][alfred] (version 4.0+)
- The [Alfred Powerpack][alfred-powerpack].
- Python 3.7+ ([Command Line Tools][command-line-tools]: `xcode-select --install` or [Homebrew][homebrew]: `brew install python`)
- The Swift Compiler `swiftc` ([Command Line Tools][command-line-tools]: `xcode-select --install`)

Additionally during the first execution and after an update of the workflow, the workflow compiles the `BatteryInfo` program. This program depends on swift and the macOS `command line tools`. [freeCodeCamp tutorial][command-line-tutorial]
During the first execution and after an update of the workflow, the workflow compiles the [`BatteryInfo`][built-in-swift] program.

## Licence, thanks

The workflow code, the bundled [Alfred-PyWorkflow][alfred-pyworkflow] library as well as the graphics are all under the [MIT Licence][mit-licence].

The original idea is from [BenziAhamed][benzi-ahamed] and his [Battery workflow][benzi-ahamed-alfred-battery]

[alfred-powerpack]: https://www.alfredapp.com/powerpack/
[alfred-pyworkflow]: https://github.com/harrtho/alfred-pyworkflow
[alfred]: https://www.alfredapp.com
[benzi-ahamed-alfred-battery]: https://github.com/BenziAhamed/alfred-battery
[benzi-ahamed]: https://github.com/BenziAhamed
[built-in-swift]: src/BatteryInfo.swift
[command-line-tutorial]: https://www.freecodecamp.org/news/install-xcode-command-line-tools/
[command-line-tools]: https://www.freecodecamp.org/news/install-xcode-command-line-tools/
[demo]: demo.gif
[downloads-shield]: https://img.shields.io/github/downloads/harrtho/alfred-battery/total.svg
[homebrew]: https://brew.sh
[licence-shield]: https://img.shields.io/github/license/harrtho/alfred-battery.svg
[mit-licence]: http://opensource.org/licenses/MIT
[python]: https://www.python.org
[releases]: https://github.com/harrtho/alfred-battery/releases
[version-shield]: https://img.shields.io/github/release/harrtho/alfred-battery.svg

0 comments on commit 9d3d34c

Please sign in to comment.