Set up Environment

• Procedure written for a Debian Ubuntu environment, but the procedure can be easily adapted for any linux distro

1. Install GNU ARM Embedded Toolchain
   1. Download  'arm-gnu-toolchain-??.?.rel?-x86_64-arm-none-eabi.tar.xz' from https://developer.arm.com/downloads/-/arm-gnu-toolchain-downloads
      1. On MacOS, you will want 'arm-gnu-toolchain-??.?.rel?-darwin-x86_64-arm-none-eabi.tar.xz'
   2. Extract code to desired directory.

      1. tar -xvf <gcc-arm-tar.bz2> -C <desired compiler location>

      2. the compile location should be somewhere permanent
   3. Set GCC_ARM_TOOLS_PATH environment variable

      1. Edit ~/.bashrc  or ~/.zshrc  depending on your shell and append the following line

         export GCC_ARM_TOOLS_PATH=<your_path_to_gcc_arm>/bin

         1. On fish, it's ~/.config/fish/config.fish

            set -gx GCC_ARM_TOOLS_PATH <your_path_to_gcc_arm>/bin

      2. On MacOS there are two possible locations you may need to put the line above. Execute the command below to determine where to place the line

         echo "$SHELL"

         If you got /bin/zsh  then add the export to ~/.zshrc , if you have /bin/bash then add the export to ~/.bash_profile .

   4. Update environment
      1. Easiest way is to restart your shell (close & open the terminal window)

      2. source ~/.bashrc  or ~/.zshrc  or ~/.config/fish/config.fish 

      3. On MacOS source ~/.zshrc  if you have ZSH or ~/.bash_profile  if you have bash

Setting Up the Environment

1. Install Cmake
   1. Download Windows installer from: https://cmake.org/download/
   2. Choose Add to path option (can choose current user or all users)
2. Install GNU ARM Tools Path
   1. Download Installer from https://developer.arm.com/open-source/gnu-toolchain/gnu-rm/downloads
      1. Should have a name similar to "gcc-arm-XXXXXXXX-mingw-w64-i686-arm-none-eabi.exe"
   2. To avoid problems later on, make sure you the path to the toolchain has no spaces
      1. You will have to manually modify the automatically generated path because it has spaces in it
      2. Ex: C:\Program_Files_No_Spaces\Arm_GNU_Toolchain_arm-none-eabi\11.2_2022.02
   3. Take note of the install location and save for later.
3. Install Git for Windows
   1. Download Installer from https://git-scm.com/download/win

Setting Up VS Code

• Light Weight Fully Fledged IDE for C/C++ development.  Provides the following useful features
  
  • Syntax highlighted and easy code navigation
  • Helpful customizations to enable high efficiency coding
  • GUI Interface for GDB Debugger for debugging code with breakpoints and memory view

1. Download VS Code: https://code.visualstudio.com/download
2. Download necessary VS Code extensions
   1. On the left hand side of the VS Code window, there is an extensions tab. Click on this tab and search for and install the following extensions:
      1. C/C++ Extension Pack
      2. Github Repositories
      3. Github Pull Requests and Issues
      4. Clang-Format
3. Set up a Github account if you do not already have one: https://github.com/join
4. Use this tutorial to setup/authorize your github account in vscode: https://docs.microsoft.com/en-us/learn/modules/introduction-to-github-visual-studio-code/
5. Set up Clang Tools
   1. Download the LLVM Windows installer from https://releases.llvm.org
      1. Make sure the version is 13.0.0 or later
      2. The installer should be titled something like "LLVM-x.x.x-win64.exe"
   2. Run the installer, making sure to select the option to add LLVM to the system PATH
   3. Clang tools will not start working until after a restart.

SSH Key Setup 

1. Run ssh-keygen in your terminal
2. Walk through the installer
3. Once the key has been generated, locate the files where the keys has been saved (chosen in the walkthrough)
4. Copy the contents of the file ending in .pub into GitHub which can be found at https://github.com/settings/keys