CHG: the loop in main, for usb_poll_validate_length, shouldn't do anything, it...

[proxmark3-svn] / README.md

diff --git a/README.md b/README.md
index b5b85e07952637a4d13d06dc97d5780218c48a4e..22efe59693947d7a73e07424cfeb76dc1abad7f4 100644 (file)
--- a/README.md
+++ b/README.md
@@ -14,16 +14,16 @@ The official Proxmark repository is found here: https://github.com/Proxmark/prox
 Download the Coverity Scan Self-buld and install it.
 You will need to configure  ARM-NON-EABI- Compiler for it to use:
 
 Download the Coverity Scan Self-buld and install it.
 You will need to configure  ARM-NON-EABI- Compiler for it to use:
 

-:: Configure
+- Configure

 `cov-configure --comptype gcc --compiler  /opt/devkitpro/devkitARM/bin/arm-none-eabi-gcc`
 
 `cov-configure --comptype gcc --compiler  /opt/devkitpro/devkitARM/bin/arm-none-eabi-gcc`
 

-::run it (I'm running on Ubuntu)
+- run it (I'm running on Ubuntu)

 `cov-build --dir cov-int make all`
 
 `cov-build --dir cov-int make all`
 

-:: make a tarball
+- make a tarball

 `tar czvf proxmark3.tgz cov-int`
 
 `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. 


@@ -113,7 +113,7 @@ 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    
+- 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
 `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


@@ -122,40 +122,40 @@ 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   
+- Extract the contents of the .tar.bz2 

 `tar jxvf devkitARM_r41-<arch>-linux.tar.bz2`
 
 `tar jxvf devkitARM_r41-<arch>-linux.tar.bz2`
 

-Create a directory for the arm dev kit 
+- Create a directory for the arm dev kit       

 `sudo mkdir -p /opt/devkitpro/`
 
 `sudo mkdir -p /opt/devkitpro/`
 

-Move the ARM developer kit to the newly created directory      
+- Move the ARM developer kit to the newly created directory    

 `sudo mv devkitARM /opt/devkitpro/`
 
 `sudo mv devkitARM /opt/devkitpro/`
 

-Add the appropriate environment variable       
+- Add the appropriate environment variable             

 `export PATH=${PATH}:/opt/devkitpro/devkitARM/bin/`
 
 `export PATH=${PATH}:/opt/devkitpro/devkitARM/bin/`
 

-Add the environment variable to your profile   
+- Add the environment variable to your profile 

 `echo 'PATH=${PATH}:/opt/devkitpro/devkitARM/bin/ ' >> ~/.bashrc`
 
 `echo 'PATH=${PATH}:/opt/devkitpro/devkitARM/bin/ ' >> ~/.bashrc`
 

-Clone iceman fork      
+- Clone iceman fork            

 `git clone https://github.com/iceman1001/proxmark3.git`
 
 `git clone https://github.com/iceman1001/proxmark3.git`
 

-Get the latest commits 
+- Get the latest commits       

 `git pull`
 
 `git pull`
 

-CLEAN COMPILE  
+- CLEAN COMPILE                

 `make clean && make all`
        
 `make clean && make all`
        

-Flash the BOOTROM      
+- Flash the BOOTROM            

 `client/flasher /dev/ttyACM0 -b bootrom/obj/bootrom.elf`
 
 `client/flasher /dev/ttyACM0 -b bootrom/obj/bootrom.elf`
 

-Flash the FULLIMAGE    
+- Flash the FULLIMAGE  

 `client/flasher /dev/ttyACM0 armsrc/obj/fullimage.elf`
        
 `client/flasher /dev/ttyACM0 armsrc/obj/fullimage.elf`
        

-Change into the client folder.         
+- Change into the client folder                

 `cd client`
        
 `cd client`
        

-Run the client 
+- Run the client       

 `./proxmark3 /dev/ttyACM0`
                                                   
 ##Homebrew (Mac OS X)
 `./proxmark3 /dev/ttyACM0`
                                                   
 ##Homebrew (Mac OS X)