add 14a apdu send framing (based on RRG repo PR86 by Merlokk) (#795)

[proxmark3-svn] / COMPILING.txt

diff --git a/COMPILING.txt b/COMPILING.txt
index 21782e2fc1e142d81cd9a332721460b53203bee5..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
-- libreadline
+- GNU libreadline or BSD libedit (editline)
 - libusb
 - perl
 - an ARM cross-compiler to compile the firmware
@@ -50,6 +50,8 @@ You only need devkitARM, nothing more (no extra lib or anything else)
 Assuming you installed it to C:\devkitpro, make sure you set
 the DEVKITARM environment variable to /c/devkitPro/devkitARM :
 export DEVKITARM=/c/devkitPro/devkitARM
+Also, add its bin to your PATH:
+export PATH=$PATH:$DEVKITARM/bin
 
 6 - Install Strawberry Perl [6]
 
@@ -79,10 +81,78 @@ Download the ProxSpace environment archive and extract it to C:\
 = Mac OS X =
 ============
 
-macport stuff should do ;)
+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
+    brew install libusb p7zip libusb-compat wget qt5 pkgconfig
+
+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
+
+4 - Edit proxmark3/client/Makefile adding path qt5
+
+    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
+
+    export DEVKITPRO=$HOME/proxmark3/
+    export DEVKITARM=$DEVKITPRO/devkitARM
+    export PATH=${PATH}:${DEVKITARM}/bin
+
 
 ============
 =   Linux  =
 ============
 
+1 - Download 
+
+A precompiled DevKitARM cross compiler tool chain package can be found at 
+http://sourceforge.net/projects/devkitpro/files/devkitARM
+Select the one you need (32bit or 64bit) and unpack to a convinient place, eg 
+$HOME/proxmark3/. It will create a devkitARM/ subdirectory.
+
+You will also need a general compiling environment on your computer for
+the client and the libusb headers. In most distributions you will get all you 
+need with the lsb-package (Linux Standard Base). In debian/ubuntu you simply 
+call `aptitude install lsb libusb-dev libreadline-dev libreadline6`. 
+
+For the graphical plot view, you might need the qtlibs (debian/ubuntu: 
+libqt4-dev), too.
+
+2 - Set Environment
+
+export DEVKITPRO=$HOME/proxmark3/
+export DEVKITARM=$DEVKITPRO/devkitARM
+export PATH=${PATH}:${DEVKITARM}/bin