Merge pull request #2651 from diorch1968/master
[RRG-proxmark3.git] / doc / md / Installation_Instructions / VSCode-Installation-Instructions.md
blob482b52af1fbfbc86887e2c335203206159b1f2b8
1 <a id="Top"></a>
3 # Visual Studio Code Installation Instructions
5 # Table of Contents
6 - [Visual Studio Code Installation Instructions](#visual-studio-code-installation-instructions)
7 - [Table of Contents](#table-of-contents)
8 - [Visual Studio Code for debugging](#visual-studio-code-for-debugging)
9   - [Debian / Ubuntu / Kali / ParrotOS / Raspbian](#debian--ubuntu--kali--parrotos--raspbian)
10   - [Windows: WSL](#windows-wsl)
11   - [Windows: ProxSpace](#windows-proxspace)
15 # Visual Studio Code for debugging
16 ^[Top](#top)
18 Download and install [Visual Studio Code](https://code.visualstudio.com/) 
20 Download and install [J-Link Software and Documentation pack](https://www.segger.com/downloads/jlink) 
23 ## Debian / Ubuntu / Kali / ParrotOS / Raspbian
24 ^[Top](#top)
26 Install dependencies
28 ```sh
29 sudo apt-get install --no-install-recommends binutils-arm-none-eabi gdb openocd gdb-multiarch
30 ```
32 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`:
33 ```sh
34 ln -s /usr/bin/gdb-multiarch /usr/bin/arm-none-eabi-gdb
35 ```
37 Setup the Visual Studio Code configuration, by going into your project folder and run:
38 ```sh
39 ./.vscode/setup.sh
40 ```
42 now launch Visual Studio Code and open your project folder
45 ## Windows: WSL
46 ^[Top](#top)
48 Enter WSL prompt (`wsl` or `start windows terminal`)
50 Install dependencies
51 ```sh
52 sudo apt-get install --no-install-recommends binutils-arm-none-eabi gdb openocd gdb-multiarch
53 ```
55 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`:
56 ```sh
57 sudo ln -s /usr/bin/gdb-multiarch /usr/bin/arm-none-eabi-gdb
58 ```
60 Setup the Visual Studio Code configuration, by going into your project folder and run:
61 ```sh
62 ./.vscode/setup.sh
63 ```
65 and launch Visual Studio Code
66 ```sh
67 code .
68 ```
71 ## Windows: ProxSpace
72 ^[Top](#top)
74 Download and install [Visual Studio Code](https://code.visualstudio.com/) 
76 Download and install [J-Link Software and Documentation pack for Windows](https://www.segger.com/downloads/jlink/JLink_Windows.exe) 
78 Enter PorxSpace (`runme64.bat`)  and enter your project folder.
80 Setup the Visual Studio Code configuration, by running:
81 ```sh
82 ./.vscode/setup.sh
83 ```
85 now launch Visual Studio Code and open your project folder
89 _note_
90 Please install the recommended Visual Studio Code extensions in order for debugging to work.