RfidResearchGroup/proxmark3
1
1
Fork 0
mirror of https://github.com/RfidResearchGroup/proxmark3.git synced 2024-09-21 07:46:12 +08:00
Code Issues Packages Projects Releases Wiki Activity

Moved vscode instructions

Browse source
This commit is contained in:
gator96100 2020-12-30 00:00:39 +01:00
parent 9bd73c4c0a
commit 483707a45a
3 changed files with 73 additions and 74 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

27
doc/md/Installation_Instructions/Linux-Installation-Instructions.md
View file

@ -25,16 +25,13 @@ Install the requirements
```sh
sudo apt-get install --no-install-recommends git ca-certificates build-essential pkg-config \
libreadline-dev gcc-arm-none-eabi libnewlib-dev qtbase5-dev libbz2-dev libbluetooth-dev \
binutils-arm-none-eabi gdb openocd gdb-multiarch
libreadline-dev gcc-arm-none-eabi libnewlib-dev qtbase5-dev libbz2-dev libbluetooth-dev
```
If you don't need the native Bluetooth support in the client, you can skip the installation of `libbluetooth-dev`.
If you don't need the graphical components of the Proxmark3 client (such as in `hw tune`), you can skip the installation of `qtbase5-dev`.
If you don't need the debugging packages, you can skip the installation of `binutils-arm-none-eabi`,`gdb`,`openocd` and `gdb-multiarch`.
If you get some (non blocking) error at runtime such as _Gtk-Message: Failed to load module "canberra-gtk-module"_ you may have to install `libcanberra-gtk-module`.
## On ArchLinux
@ -115,25 +112,3 @@ It must return `ok`. Otherwise this means you've got a permission problem to fix
# Compile and use the project
Now you're ready to follow the [compilation instructions](/doc/md/Use_of_Proxmark/0_Compilation-Instructions.md).
## (Optional) Visual Studio Code debugging
Download and install [Visual Studio Code](https://code.visualstudio.com/)
Download and install [J-Link Software and Documentation pack](https://www.segger.com/downloads/jlink)
On some systems `arm-none-eabi-gdb` was replaced with `gdb-multiarch`. In order to use the J-Link debugger you need to link `arm-none-eabi-gdb` to `gdb-multiarch`:
```sh
ln -s /usr/bin/gdb-multiarch /usr/bin/arm-none-eabi-gdb
```
Setup the Visual Studio Code configuration, by going into your project folder and run:
```sh
./.vscode/setup.sh
```
now launch Visual Studio Code and open your project folder
_note_
Please install the recommended Visual Studio Code extensions in order for debugging to work.

72
doc/md/Installation_Instructions/VSCode-Installation-Instructions.md Normal file
View file

@ -0,0 +1,72 @@
# Visual Studio Code for debugging
Download and install [Visual Studio Code](https://code.visualstudio.com/)
Download and install [J-Link Software and Documentation pack](https://www.segger.com/downloads/jlink)
## Debian / Ubuntu / Kali / ParrotOS / Raspbian
Install dependencies
```sh
sudo apt-get install --no-install-recommends binutils-arm-none-eabi gdb openocd gdb-multiarch
```
On some systems `arm-none-eabi-gdb` was replaced with `gdb-multiarch`. In order to use the J-Link debugger you need to link `arm-none-eabi-gdb` to `gdb-multiarch`:
```sh
ln -s /usr/bin/gdb-multiarch /usr/bin/arm-none-eabi-gdb
```
Setup the Visual Studio Code configuration, by going into your project folder and run:
```sh
./.vscode/setup.sh
```
now launch Visual Studio Code and open your project folder
## Windows: WSL
Enter WSL prompt (`wsl` or `start windows terminal`)
Install dependencies
```sh
sudo apt-get install --no-install-recommends binutils-arm-none-eabi gdb openocd gdb-multiarch
```
The J-Link debugger requires `arm-none-eabi-gdb` which was replaced with `gdb-multiarch`. In order to use the J-Link debugger link `arm-none-eabi-gdb` to `gdb-multiarch`:
```sh
sudo ln -s /usr/bin/gdb-multiarch /usr/bin/arm-none-eabi-gdb
```
Setup the Visual Studio Code configuration, by going into your project folder and run:
```sh
./.vscode/setup.sh
```
and launch Visual Studio Code
```sh
code .
```
## Windows: ProxSpace
Download and install [Visual Studio Code](https://code.visualstudio.com/)
Download and install [J-Link Software and Documentation pack for Windows](https://www.segger.com/downloads/jlink/JLink_Windows.exe)
Enter PorxSpace (`runme64.bat`) and enter your project folder.
Setup the Visual Studio Code configuration, by running:
```sh
./.vscode/setup.sh
```
now launch Visual Studio Code and open your project folder
_note_
Please install the recommended Visual Studio Code extensions in order for debugging to work.

48
doc/md/Installation_Instructions/Windows-Installation-Instructions.md
View file

@ -64,24 +64,6 @@ To use the compiled client, the only differences are that executables end with `
Now you're ready to follow the [compilation instructions](/doc/md/Use_of_Proxmark/0_Compilation-Instructions.md).
## (Optional) Visual Studio Code debugging
Download and install [Visual Studio Code](https://code.visualstudio.com/)
Download and install [J-Link Software and Documentation pack for Windows](https://www.segger.com/downloads/jlink/JLink_Windows.exe)
Enter PorxSpace (`runme64.bat`) and enter your project folder.
Setup the Visual Studio Code configuration, by running:
```sh
./.vscode/setup.sh
```
now launch Visual Studio Code and open your project folder
_note_
Please install the recommended Visual Studio Code extensions in order for debugging to work.
# Installing on Windows with WSL 1
WSL 1 requires to run on Windows 10 version 1709 or above. Previous windows versions didn't have support for COM ports.
@ -167,33 +149,3 @@ Note that it may take a quite long time for a freshly plugged Proxmark3 to be vi
Now you're ready to follow the [compilation instructions](/doc/md/Use_of_Proxmark/0_Compilation-Instructions.md).
## (Optional) Visual Studio Code debugging
Download and install [Visual Studio Code](https://code.visualstudio.com/)
Download and install [J-Link Software and Documentation pack for Windows](https://www.segger.com/downloads/jlink/JLink_Windows.exe)
Enter WSL prompt (`wsl` or `start windows terminal`) and from there, follow the [Linux Installation Instructions](/doc/md/Installation_Instructions/Linux-Installation-Instructions.md) for Ubuntu, summarized here below:
Install dependencies
```sh
sudo apt-get install --no-install-recommends binutils-arm-none-eabi gdb openocd gdb-multiarch
```
The J-Link debugger requires `arm-none-eabi-gdb` which was replaced with `gdb-multiarch`. In order to use the J-Link debugger link `arm-none-eabi-gdb` to `gdb-multiarch`:
```sh
sudo ln -s /usr/bin/gdb-multiarch /usr/bin/arm-none-eabi-gdb
```
Setup the Visual Studio Code configuration, by going into your project folder and run:
```sh
./.vscode/setup.sh
```
and launch Visual Studio Code
```sh
code .
```
_note_
Please install the recommended Visual Studio Code extensions in order for debugging to work.