Skip to content

Commit d2fb266

Browse files
Add build and download instructions to Readme
1 parent 95d782f commit d2fb266

File tree

1 file changed

+17
-2
lines changed

1 file changed

+17
-2
lines changed

Readme.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,27 @@ Funky maintains a list of apps for which it will set the function key to standar
1313

1414
Use GitHub's [issue tracker](https://github.com/thecatalinstan/Funky/issues) to submit bug reports feature requests, or just to say hi.
1515

16-
## Privacy Policy
16+
## Pre-Built Binaries
1717

18-
Please carefully read the [Privacy Policy](https://github.com/thecatalinstan/Funky/blob/master/Privacy.md).
18+
You can download pre-built binaries of Funky from two sources:
19+
20+
- **GitHub:** see the [Releases](https://github.com/thecatalinstan/Funky/releases) section. [https://github.com/thecatalinstan/Funky/releases](https://github.com/thecatalinstan/Funky/releases)
21+
- **Mac AppStore:** free to download from the [Mac AppStore](https://itunes.apple.com/app/funky/id1210707379) at [https://itunes.apple.com/app/funky/id1210707379](https://itunes.apple.com/app/funky/id1210707379).
22+
23+
## Building
24+
25+
Building should be straightforward, except for one little caveat: Funky is also distributed through the Mac AppStore, therefore it performs a [MAS receipt validation](https://developer.apple.com/library/archive/releasenotes/General/ValidateAppStoreReceipt/Introduction.html#//apple_ref/doc/uid/TP40010573-CH105-SW1).
26+
27+
This means that if you try to run a *release* build, it will fail to start as there is no actual Mac AppStore receipt present.
28+
29+
In order to disable the check, simply set the `DEVELOPMENT` variable to `1`, either in the `main.m` file or through a compile-time define.
1930

2031
---
2132

2233
## Contributors Welcome
2334

2435
Since my time is fairly limited, contributions are more than welcome to, well, *contribute*. If you think Funky is a useful tool and your macOS kung-fu is strong, feel free to fork and submit a pull request.
36+
37+
## Privacy Policy
38+
39+
Please carefully read the [Privacy Policy](https://github.com/thecatalinstan/Funky/blob/master/Privacy.md).

0 commit comments

Comments
 (0)