update instructions

This commit is contained in:
Philippe Teuwen 2019-09-03 22:54:42 +02:00
commit b577ca15e9
6 changed files with 116 additions and 36 deletions

View file

@ -24,27 +24,52 @@ git pull
make clean && make all
```
## Install
This is an optional step. If you do
```sh
sudo make install
```
Then the required files will be installed on your system, by default in `/usr/local/bin` and `/usr/local/share/proxmark3`.
Maintainers can read [this doc](../Development/Maintainers.md) to learn how to modify installation paths via `DESTDIR` and `PREFIX` Makefile variables.
The commands given in the documentation assume you did the installation step. If you didn't, you've to adjust the commands paths and files paths accordingly,
e.g. calling `./pm3` or `client/proxmark3` instead of just `pm3` or `proxmark3`.
## Flash the BOOTROM & FULLIMAGE
In most cases, you can run the script `flash-all.sh` which try to auto-detect the port to use, on several OS.
In most cases, you can run the script `pm3-flash-all` which try to auto-detect the port to use, on several OS.
For the other cases, specify the port by yourself. For example, for a Proxmark3 connected via USB under Linux:
```sh
proxmark3-flasher /dev/ttyACM0 -b /usr/local/share/proxmark3/firmware/bootrom.elf /usr/local/share/proxmark3/firmware/fullimage.elf
```
or from the local repo
```sh
client/proxmark3-flasher /dev/ttyACM0 -b bootrom/obj/bootrom.elf armsrc/obj/fullimage.elf
```
## Run the client
In most cases, you can run the script `proxmark3.sh` which try to auto-detect the port to use, on several OS.
In most cases, you can run the script `pm3` which try to auto-detect the port to use, on several OS.
For the other cases, specify the port by yourself. For example, for a Proxmark3 connected via USB under Linux:
Here, for example, for a Proxmark3 connected via USB under Linux:
```sh
cd client
./proxmark3 /dev/ttyACM0
proxmark3 /dev/ttyACM0
```
or from the local repo
```sh
client/proxmark3 /dev/ttyACM0
```
## Next steps

View file

@ -46,7 +46,9 @@ Don't not turn off your device during the execution of this command!!
Even its a quite fast command you should be warned. You may brick it if you interrupt it.
```
pm3 --> sc upgrade f ../tools/simmodule/sim011.bin
pm3 --> sc upgrade f /usr/local/share/proxmark3/firmware/sim011.bin
# or if from local repo
pm3 --> sc upgrade f tools/simmodule/sim011.bin
```
You get the following output if the execution was successful: