Merge pull request #343 from Fl0-0/master

[proxmark3-svn] / COMPILING.txt

diff --git a/COMPILING.txt b/COMPILING.txt
index 1cc34a0fc008309d1376b1755ceeb09e19c9ae3a..bd5bef1c3ea67a707f4a5ec31909794c56f7c7e1 100644 (file)
--- a/COMPILING.txt
+++ b/COMPILING.txt
@@ -3,7 +3,7 @@ The project compiles on Linux, Mac OS X and Windows (MinGW/MSYS).
 it requires:
 - gcc >= 4.4
 - libpthread
 it requires:
 - gcc >= 4.4
 - libpthread

-- libreadline
+- GNU libreadline or BSD libedit (editline)

 - libusb
 - perl
 - an ARM cross-compiler to compile the firmware
 - libusb
 - perl
 - an ARM cross-compiler to compile the firmware


@@ -81,24 +81,48 @@ Download the ProxSpace environment archive and extract it to C:\
 = Mac OS X =
 ============
 
 = Mac OS X =
 ============
 

+Installing from HomeBrew tap
+---------------------------
+This method is recommended and tested on macOS Sierra 10.12.3
+
+1. Install homebrew if you haven't yet already done so: http://brew.sh/
+
+2. Tap proxmark repo:
+    brew tap proxmark/proxmark3 
+
+3. Install Proxmark3:
+
+Stable release
+    brew install proxmark3
+
+Latest non-stable from GitHub (use this if previous command fails)
+    brew install --HEAD proxmark3
+
+For more information go to https://github.com/Proxmark/homebrew-proxmark3
+
+
+Compilling from source manually (Legacy)
+---------------------------
+

 Tested on OSX 10.10 Yosemite
 
 1 - Install Xcode and Xcode Command Line Tools
 
 2 - Install Homebrew and dependencies
 Tested on OSX 10.10 Yosemite
 
 1 - Install Xcode and Xcode Command Line Tools
 
 2 - Install Homebrew and dependencies

-    brew install readline
-    brew instal libusb
-
-3 - Download DevKitARM for OSX
-    http://sourceforge.net/projects/devkitpro/files/devkitARM/devkitARM_r44/
-    Unpack devkitARM_r44-osx.tar.bz2 to proxmark3 directory.
+    brew install libusb p7zip libusb-compat wget qt5 pkgconfig

 
 

-4 - Edit proxmark3/client/Makefile adding path to readline
+3 - Install DevKitARM for OSX
+    Option 1:
+        http://sourceforge.net/projects/devkitpro/files/devkitARM/devkitARM_r44/
+        Unpack devkitARM_r44-osx.tar.bz2 to proxmark3 directory.
+    Option 2:
+        brew tap nitsky/stm32
+        brew install arm-none-eabi-gcc

 
 

-    LDLIBS = -L/usr/local/Cellar/readline/6.3.8/lib/ -L/opt/local/lib -L/usr/local/lib ../liblua/liblua.a -lreadline -lpthread -lm
-    CFLAGS = -std=c99 -I/usr/local/Cellar/readline/6.3.8/include/ -I. -I../include -I../common -I/opt/local/include -I../liblua  -Wall $(COMMON_FLAGS) -g -O4
+4 - Edit proxmark3/client/Makefile adding path qt5

 
 

-    Replace path /usr/local/Cellar/readline/6.3.8 with your actuall readline path. See homebrew manuals.
+    LDLIBS = -L/usr/local/opt/qt5/lib -L/opt/local/lib -L/usr/local/lib ../liblua/liblua.a -lreadline -lpthread -lm
+    CFLAGS = -std=c99 -I/usr/local/opt/qt5/include -I. -I../include -I../common -I../zlib -I/opt/local/include -I../liblua -Wall $(COMMON_FLAGS) -g -O4

 
 5 - Set Environment
 
 
 5 - Set Environment