proxmark3/doc/md/Use_of_Proxmark/0_Compilation-Instructions.md

58 lines
1.7 KiB
Markdown
Raw Normal View History

2019-05-06 01:53:58 +08:00
# Compilation instructions
2019-07-12 07:48:39 +08:00
## Tuning compilation parameters
The client and the Proxmark3 firmware should always be in sync.
Nevertheless, the firmware can be tuned depending on the Proxmark3 platform and options.
Indeed, the RRG/Iceman fork can be used on other Proxmark3 hardware platforms as well.
Via some definitions, you can adjust the firmware for a given platform, but also to add features like the support of the Blue Shark add-on or to select which standalone mode to embed.
To learn how to adjust the firmware, please read [Advanced compilation parameters](/doc/md/Use_of_Proxmark/4_Advanced-compilation-parameters.md).
2019-05-06 01:53:58 +08:00
## Get the latest commits
```sh
cd proxmark3
git pull
```
## Clean and compile everything
```sh
make clean && make all
```
## Flash the BOOTROM & FULLIMAGE
2019-07-12 07:48:39 +08:00
In most cases, you can run the script `flash-all.sh` which try to auto-detect the port to use, on several OS.
2019-05-06 01:53:58 +08:00
2019-07-12 07:48:39 +08:00
For the other cases, specify the port by yourself. For example, for a Proxmark3 connected via USB under Linux:
2019-05-06 01:53:58 +08:00
```sh
2019-07-12 07:48:39 +08:00
client/flasher /dev/ttyACM0 -b bootrom/obj/bootrom.elf armsrc/obj/fullimage.elf
2019-05-06 01:53:58 +08:00
```
2019-07-12 07:48:39 +08:00
## Run the client
2019-07-12 07:48:39 +08:00
In most cases, you can run the script `proxmark3.sh` which try to auto-detect the port to use, on several OS.
2019-07-12 07:48:39 +08:00
For the other cases, specify the port by yourself. For example, for a Proxmark3 connected via USB under Linux:
2019-07-12 07:48:39 +08:00
Here, for example, for a Proxmark3 connected via USB under Linux:
```sh
cd client
./proxmark3 /dev/ttyACM0
```
2019-05-06 01:53:58 +08:00
## Next steps
For the next steps, please read the following pages:
* [Validating proxmark client functionality](/doc/md/Use_of_Proxmark/1_Validation.md)
* [First Use and Verification](/doc/md/Use_of_Proxmark/2_Configuration-and-Verification.md)
2019-05-06 02:05:02 +08:00
* [Commands & Features](/doc/md/Use_of_Proxmark/3_Commands-and-Features.md)
2019-05-06 01:53:58 +08:00