From fd700f73e59d2912d5fe70a1339ebaa34b619360 Mon Sep 17 00:00:00 2001 From: Ryan Holmes Date: Sun, 15 May 2016 12:53:37 -0400 Subject: [PATCH] Update README.md --- README.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index e4feb9699..a5f89ee6d 100644 --- a/README.md +++ b/README.md @@ -14,8 +14,13 @@ The latest version along with release notes can always be found on the project's ## Installation Windows and OS X users are supplied self-contained builds of pyfa on the [latest releases](https://github.com/pyfa-org/Pyfa/releases/latest) page. An `.exe` installer is also available for Windows builds. Linux users can run pyfa using their distribution's Python interpreter. There is no official self-contained package for Linux, however, there are a number of third-party packages available through distribution-specific repositories. -### OS X -If you got [Homebrew](http://brew.sh), simply fire up in terminal: +#### OS X +There are two different distributives for OS X: `-mac` and `-mac-deprecated`. + +* `-mac`: based on wxPython 3.0.2.0 and has updated libraries. This is the recommended build. +* `-mac-deprecated`: utilizes older binaries running on wxPython 2.8; because of this, some features are not available (currently CREST support and Attribute Overrides). Additionally, as development happens primarily on wxPython 3.0, a few GUI bugs may pop up as `-mac-deprecated` is not actively tested. However, due to some general issues with wxPython 3.0, especially on some newer OS X versions, `-mac-deprecated` is still offered for those that need it. + +There is also a [Homebrew](http://brew.sh) option for installing pyfa on OS X. Please note this is maintained by a third-party and is not tested by pyfa developers. Simply fire up in terminal: ``` $ brew cask install pyfa ```