]> git.zerfleddert.de Git - proxmark3-svn/blobdiff - README.md
Update README.md
[proxmark3-svn] / README.md
index 5667fc34cf1a36fa1814e6dea097203c58329052..daadb598411a48c5029dc5b66146f48392024094 100644 (file)
--- a/README.md
+++ b/README.md
@@ -2,28 +2,32 @@ The iceman fork
 ===============
 [![Build Status](https://travis-ci.org/iceman1001/proxmark3.svg?branch=master)](https://travis-ci.org/iceman1001/proxmark3)  [![Coverity Status](https://scan.coverity.com/projects/5117/badge.svg)](https://scan.coverity.com/projects/proxmark3_iceman_fork)  [![Latest release] (https://img.shields.io/github/release/iceman1001/proxmark3.svg)] (https://github.com/iceman1001/proxmark3/releases/latest)
 
 ===============
 [![Build Status](https://travis-ci.org/iceman1001/proxmark3.svg?branch=master)](https://travis-ci.org/iceman1001/proxmark3)  [![Coverity Status](https://scan.coverity.com/projects/5117/badge.svg)](https://scan.coverity.com/projects/proxmark3_iceman_fork)  [![Latest release] (https://img.shields.io/github/release/iceman1001/proxmark3.svg)] (https://github.com/iceman1001/proxmark3/releases/latest)
 
-##This fork is HIGHLY experimental
+##This fork is HIGHLY experimental (or bleeding edge)
+
+##Donate
+https://paypal.me/iceman1001/
+Feel free to donate. All support is welcome.
 
 ##Notice      
 
 ##Notice      
-There is so much in this fork,  with all fixes and additions its basically the most enhanced fork to this day for the Proxmark3 device.
+There is so much in this fork,  with all fixes and additions its basically the most enhanced fork to this day for the Proxmark3 device. Which makes it so awesum to play with. Do please play with it. Get excited and experiment. As a side note with all coverity scan fixes this client is much more stable than PM3 Master even if I tend to break it sometimes. I'll try to make a release when this fork becomes stable between my experiments.
 
 
-##Offical
+##Official
 The official Proxmark repository is found here: https://github.com/Proxmark/proxmark3
 
 ##Coverity Scan Config & Run
 Download the Coverity Scan Self-buld and install it.
 You will need to configure  ARM-NON-EABI- Compiler for it to use:
 
 The official Proxmark repository is found here: https://github.com/Proxmark/proxmark3
 
 ##Coverity Scan Config & Run
 Download the Coverity Scan Self-buld and install it.
 You will need to configure  ARM-NON-EABI- Compiler for it to use:
 
-:: Configure
-cov-configure --comptype gcc --compiler  /opt/devkitpro/devkitARM/bin/arm-none-eabi-gcc
+- Configure
+`cov-configure --comptype gcc --compiler  /opt/devkitpro/devkitARM/bin/arm-none-eabi-gcc`
 
 
-::run it (I'm running on Ubuntu)
-cov-build --dir cov-int make all
+run it (I'm running on Ubuntu)
+`cov-build --dir cov-int make all`
 
 
-:: make a tarball
-tar czvf proxmark3.tgz cov-int
+- make a tarball
+`tar czvf proxmark3.tgz cov-int`
 
 
-:: upload it to coverity.com
+- upload it to coverity.com
 
 ##Whats changed?
 Whats so special with this fork?  I have scraped the web for different enhancements to the PM3 source code and not all of them ever found their way to the master branch. 
 
 ##Whats changed?
 Whats so special with this fork?  I have scraped the web for different enhancements to the PM3 source code and not all of them ever found their way to the master branch. 
@@ -43,14 +47,13 @@ Among the stuff is
        * Minor textual changes here and there.
        * Simulation of Ultralight/Ntag.
        * Marshmellow's and my "RevEng" addon for the client.  Ref: http://reveng.sourceforge.net/    Now using reveng1.31
        * Minor textual changes here and there.
        * Simulation of Ultralight/Ntag.
        * Marshmellow's and my "RevEng" addon for the client.  Ref: http://reveng.sourceforge.net/    Now using reveng1.31
-       * Someone's alternative bruteforce Mifare changes.. (you need the two other exe to make it work)
-
+       * J-Run alternative bruteforce Mifare nested auths.. (you need one other exe to make it work)
        * A Bruteforce for T55XX passwords against tag.
        * A Bruteforce for AWID 26, starting w a facilitycode then trying all 0xFFFF cardnumbers via simulation. To be used against a AWID Reader.
        * A Bruteforce for HID,  starting w a facilitycode then trying all 0xFFFF cardnumbers via simulation. To be used against a HID Reader.
        * Blaposts Crapto1 v3.3
        * A Bruteforce for T55XX passwords against tag.
        * A Bruteforce for AWID 26, starting w a facilitycode then trying all 0xFFFF cardnumbers via simulation. To be used against a AWID Reader.
        * A Bruteforce for HID,  starting w a facilitycode then trying all 0xFFFF cardnumbers via simulation. To be used against a HID Reader.
        * Blaposts Crapto1 v3.3
-        * Icsom's  legic script and legic enhancements
-        * Aczid's bitsliced bruteforce solver in 'hf mf hardnested'
+    * Icsom's  legic script and legic enhancements
+    * Aczid's bitsliced bruteforce solver in 'hf mf hardnested'
 
 ##Straight from the CHANGELOG
 =============================
 
 ##Straight from the CHANGELOG
 =============================
@@ -95,7 +98,6 @@ Among the stuff is
   - Added the experimental HITAG_S support (spenneb)
   - Added topaz detection to `hf search` (iceman)
   - Fixed the silent mode for 14b to be used inside `hf search` (iceman)
   - Added the experimental HITAG_S support (spenneb)
   - Added topaz detection to `hf search` (iceman)
   - Fixed the silent mode for 14b to be used inside `hf search` (iceman)
-  
        
 ---    
 Give me a hint, and I'll see if I can't merge in the stuff you have. 
        
 ---    
 Give me a hint, and I'll see if I can't merge in the stuff you have. 
@@ -115,8 +117,8 @@ This fork now compiles just fine on
 GC made updates to allow this to build easily on Ubuntu 14.04.2 LTS or 15.10
 See https://github.com/Proxmark/proxmark3/wiki/Ubuntu%20Linux
 
 GC made updates to allow this to build easily on Ubuntu 14.04.2 LTS or 15.10
 See https://github.com/Proxmark/proxmark3/wiki/Ubuntu%20Linux
 
-Run 
-       -> sudo apt-get install p7zip git build-essential libreadline5 libreadline-dev libusb-0.1-4 libusb-dev libqt4-dev perl pkg-config wget libncurses5-dev
+- Run          
+`sudo apt-get install p7zip git build-essential libreadline5 libreadline-dev libusb-0.1-4 libusb-dev libqt4-dev perl pkg-config wget libncurses5-dev`
        
 Follow these instructions
 Get devkitARM release 41 from SourceForge (choose either the 64/32 bit depending on your architecture, it is assumed you know how to check and recognize your architecture):
        
 Follow these instructions
 Get devkitARM release 41 from SourceForge (choose either the 64/32 bit depending on your architecture, it is assumed you know how to check and recognize your architecture):
@@ -124,41 +126,41 @@ Get devkitARM release 41 from SourceForge (choose either the 64/32 bit depending
 (64-bit) http://sourceforge.net/projects/devkitpro/files/devkitARM/previous/devkitARM_r41-x86_64-linux.tar.bz2/download
 (32-bit) http://sourceforge.net/projects/devkitpro/files/devkitARM/previous/devkitARM_r41-i686-linux.tar.bz2/download
 
 (64-bit) http://sourceforge.net/projects/devkitpro/files/devkitARM/previous/devkitARM_r41-x86_64-linux.tar.bz2/download
 (32-bit) http://sourceforge.net/projects/devkitpro/files/devkitARM/previous/devkitARM_r41-i686-linux.tar.bz2/download
 
-Extract the contents of the .tar.bz2:
-       ->  tar jxvf devkitARM_r41-<arch>-linux.tar.bz2
+- Extract the contents of the .tar.bz2 
+`tar jxvf devkitARM_r41-<arch>-linux.tar.bz2`
 
 
-Create a directory for the arm dev kit:
-       ->  sudo mkdir -p /opt/devkitpro/
+- Create a directory for the arm dev kit       
+`sudo mkdir -p /opt/devkitpro/`
 
 
-Move the ARM developer kit to the newly created directory:
-       -> sudo mv devkitARM /opt/devkitpro/
+- Move the ARM developer kit to the newly created directory    
+`sudo mv devkitARM /opt/devkitpro/`
 
 
-Add the appropriate environment variable:
-       -> export PATH=${PATH}:/opt/devkitpro/devkitARM/bin/
+- Add the appropriate environment variable             
+`export PATH=${PATH}:/opt/devkitpro/devkitARM/bin/`
 
 
-Add the environment variable to your profile:
-       -> echo 'PATH=${PATH}:/opt/devkitpro/devkitARM/bin/ ' >> ~/.bashrc
+- Add the environment variable to your profile 
+`echo 'PATH=${PATH}:/opt/devkitpro/devkitARM/bin/ ' >> ~/.bashrc`
 
 
-Clone iceman fork
-       -> git clone https://github.com/iceman1001/proxmark3.git
+- Clone iceman fork            
+`git clone https://github.com/iceman1001/proxmark3.git`
 
 
-Get the latest commits 
-       -> git pull
+- Get the latest commits       
+`git pull`
 
 
-CLEAN COMPILE  
-       -> make clean && make all
+- CLEAN COMPILE                
+`make clean && make all`
        
        
-Flash the BOOTROM
-       -> client/flasher -b /dev/ttyACM0 bootrom/obj/bootrom.elf
+- Flash the BOOTROM            
+`client/flasher /dev/ttyACM0 -b bootrom/obj/bootrom.elf`
 
 
-Flash the FULLIMAGE    
-       -> client/flasher /dev/ttyACM0 armsrc/obj/fullimage.elf
+- Flash the FULLIMAGE  
+`client/flasher /dev/ttyACM0 armsrc/obj/fullimage.elf`
        
        
-Change into the client folder.         
-       -> cd client
+- Change into the client folder                
+`cd client`
        
        
-Run the client 
-       -> ./proxmark3 /dev/ttyACM0
+- Run the client       
+`./proxmark3 /dev/ttyACM0`
                                                   
 ##Homebrew (Mac OS X)
 These instructions comes from @Chrisfu, where I got the proxmark3.rb scriptfile from.
                                                   
 ##Homebrew (Mac OS X)
 These instructions comes from @Chrisfu, where I got the proxmark3.rb scriptfile from.
@@ -179,7 +181,7 @@ Follow those instructions to get it up and running.  No need for the old proxspa
 [1.6.1] How to flash:   https://www.youtube.com/watch?v=WXouhuGYEiw
 
 Recommendations:
 [1.6.1] How to flash:   https://www.youtube.com/watch?v=WXouhuGYEiw
 
 Recommendations:
-Use only container tag [1.6.1]
+Use only container tag [1.6.4]
 
 
 ##Buying a proxmark3
 
 
 ##Buying a proxmark3
@@ -189,8 +191,6 @@ The Proxmark 3 device is available for purchase (assembled and tested) from the
  
    * http://www.elechouse.com/  (new and revised hardware package 2015, located in China)  
 
  
    * http://www.elechouse.com/  (new and revised hardware package 2015, located in China)  
 
-   I recommend you to buy this version. 
-
 
 ##Enjoy
 
 
 ##Enjoy
 
Impressum, Datenschutz