diff --git a/README.md b/README.md index 64e2017..c091d88 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -
+
+
+
+
+
+
+
### How it works
-5 GUIs grabs some information from the app bundle.
-It then uses LLVM's objdump to check what libraries the app links,
-e.g. Electron or UIKit, to figure out what technology is being used.
+[5 GUIs](https://zeezide.com/en/products/5guis/index.html)
+first grabs some information from the app bundle.
+It then uses [LLVM](https://llvm.org)'s
+[`objdump`](https://en.wikipedia.org/wiki/Objdump)
+to check what libraries the app links,
+e.g. [Electron](https://www.electronjs.org) or
+[UIKit](https://developer.apple.com/documentation/uikit), to figure out what technology is being used.
-5 GUIs itself is a SwiftUI application.
+[5 GUIs](https://zeezide.com/en/products/5guis/index.html)
+itself is a [SwiftUI](https://developer.apple.com/xcode/swiftui/) 1
+macOS application (i.e. it runs on Catalina and macOS BS).
### Idea and Implementation
The idea for this kind of app exists for quite some time, but when
[@jckarter](https://twitter.com/jckarter)
-tweeted the proper name for this, "5 GUIs", it finally had to be done.
+tweeted the proper name for this: โ5 GUIsโ, it finally had to be done.
This is a quick hack, put together in about 2 days.
-The source is not "nice" at all, don't use it as a proper example ๐
+The source is not โniceโ at all, don't use it as a proper example ๐
PRs with cleanups are warmly welcome.
@@ -39,6 +54,8 @@ has the time to add some fancy animations,
better colors, iconography and styling,
that would be *very* welcome!
+Also checkout the Issues page of this repository. It'll have some.
+
### 3rd Party Software Used
@@ -54,9 +71,9 @@ For testing purposes the one included in Xcode should be fine,
it should be living over here:
`/Applications/Xcode.app//Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/bin/llvm-objdump`.
-For deployment it is probably better to build and own one.
+For deployment it is probably better to build an own one.
To do so:
-- grab the `LLVM source code` from the
+- grab the LLVM source code from the
[downloads page](https://releases.llvm.org/download.html#10.0.1)
- Unpack it somewhere, e.g.: `cd /tmp; && tar zxf llvm-10.0.1.src.tar.xz`
- Create a build dir: `mkdir /tmp/build-dir && cd /tmp/build-dir`