How to setup environment

Optional:

1. Install Visual Studio Code here to use it as a difftool/mergetool.

Windows Installation Guide

1. Install Git here.
   • During installation, you will be asked several configuration questions; you can keep all the defaults.
2. (Optional) Install GitHub Desktop here.
3. Install the Microsoft compiler (MSVC) here and install the "Desktop development with C++" workload.
   • This step is not needed if you already have Visual Studio installed.
   • wiRedPanda also compiles with GCC/Clang but on Windows the Microsoft compiler (MSVC) is 6x faster.
4. Install Qt here.
   • For Qt5: Check the "Archive" filter, then select "MSVC 2019 32-bit" under Qt 5.15.2.
   • For Qt6: Use the latest version available, select "MSVC 2022 64-bit", and in "Additional Libraries", select "Qt Multimedia".
5. Clone the repository to your computer.
   • Note: Do not use the "Download ZIP" button, as it does not include the .git folder, preventing you from committing changes.
   • Using GitHub Desktop: Click the green "<> Code" button on the repository homepage, then click "Open with GitHub Desktop" to clone the repository into your chosen folder.
   • Using Git directly: Run the following command:

     git clone https://github.com/GIBIS-UNIFESP/wiRedPanda

6. Open Qt Creator and click "Open Project". Navigate to the wiRedPanda folder and select the WPanda.pro file.
7. Click the Play button (bottom left) to compile and run.
8. Done! 🎉

Linux Installation Guide

1. Install Git:

sudo apt-get install git

2. Install GCC:

sudo apt-get install build-essential

3. Install Qt:
   • For Qt5:

     sudo apt-get install qtbase5-dev qtmultimedia5-dev libqt5svg5-dev

   • For Qt6:

     sudo apt-get install qt6-base-dev qt6-multimedia-dev qt6-svg-dev

4. Clone the repository to your computer:

git clone https://github.com/GIBIS-UNIFESP/wiRedPanda

5. Open Qt Creator and click "Open Project". Navigate to the wiRedPanda folder and select the WPanda.pro file.
6. Click the Play button (bottom left) to compile and run.
7. Done! 🎉

macOS Installation Guide

1. Install Git:

brew install git

2. Install Xcode Command Line Tools:

xcode-select --install

3. Install Qt:
   • For Qt5:

     brew install qt@5

   • For Qt6:

     brew install qt

4. Clone the repository to your computer:

git clone https://github.com/GIBIS-UNIFESP/wiRedPanda

5. Open Qt Creator and click "Open Project". Navigate to the wiRedPanda folder and select the WPanda.pro file.
6. Click the Play button (bottom left) to compile and run.
7. Done! 🎉

TODO

• show how to use the vscode mergetool
• show how to config vscode in github desktop
• show how to use vscode to compile/run wiRedPanda using cmake (need cmake and c++ extensions)
• add ccache step