Peter's Windows Port

Getting Set Up - Windows

Install MSYS2
Run MSYS2: MSYS2 MinGW 64-bit from the Windows Start Menu.
- Make sure you are running the correct executable or else you will have trouble with the C++ compiler not recognizing your system correctly.
pacman -S git nano make cmake mingw64/mingw-w64-x86_64-gcc mingw-w64-x86_64-gdb mingw-w64-x86_64-gcc mingw-w64-x86_64-toolchain mingw-w64-x86_64-zlib mingw-w64-x86_64-freetype mingw-w64-x86_64-glfw mingw-w64-x86_64-mpv mingw-w64-x86_64-youtube-dl bison flex
- If you are having troubles: the full list I installed was: pacman -S git nano make cmake mingw64/mingw-w64-x86_64-gcc mingw-w64-x86_64-gdb mingw-w64-x86_64-gcc mingw-w64-x86_64-toolchain mingw-w64-x86_64-zlib mingw-w64-x86_64-freetype mingw-w64-x86_64-glfw bison flex python pkg-config mingw-w64-x86_64-gcc mingw-w64-x86_64-eigen3 mingw-w64-x86_64-qt5 mingw-w64-x86_64-mpv mingw-w64-x86_64-youtube-dl
Edit ~/.bashrc to include export GRAIL=/path/to/GRAIL and export PATH=$PATH:$GRAIL/bin on the following line. source ~/.bashrc the first time.

Getting Set Up - Ubuntu

Install Dependencies: sudo apt install make libglfw3-dev libfreetype-dev mpv libmpv-dev flex bison
Refer to step 4 of Getting Set up - Windows to set up the environment variables.

Getting Set Up - Arch-Based Linux

Install Dependencies: sudo pacman -S glfw-x11 freetype2 base-devel mpv youtube-dl
- If you are using Wayland, there install glfw-wayland instead of glfw-x11. Wayland support is currently unconfirmed.
Refer to step 4 of Getting Set up - Windows to set up the environment variables.

Compiling

cd $GRAIL/ ; make

Running

Update $GRAIL/test/Makefile to compile the file you want to compile.
cd $GRAIL/test/ && testDrawing
- Cursors and other features might not work for other tests as they are not 100% Linux/Windows compatible yet.

Frequent Issues

Need to create an SSH key to push into the repository

GitHub has a great guide on how to do this! This guide will show you how to load ssh-agent when your terminal starts and add a new SSH key to ssh-agent and GitHub

Cloned the repository using HTTPS, but now have to push to the repository

In this instance, you'll need to change the remote url that git is pointing to. This can be done with a single git command that changes which website the remote called origin is pointing at. Once you run this, try to push again and you should be good to go!

Git command:

    git remote set-url origin git@github.com:StevensDeptECE/GrailGUI.git

Compile Time Error: `Makefile:1: /proj/settings.mk: No such file or directory`

The GRAIL environment variable is most likely not set. Please refer to step 4 of Getting Set up - Windows. If you have done this and still find yourself getting the same error, you may using a shell besides Bash. This is important because the instructions provided tell you to edit the .bashrc, but that file may not be loaded if you were zsh, ksh, fish, or another alternative. To check which shell you are running, use one of the solutions mentioned here and then look up which file you would edit to export environment variables.

Runtime Error: `Failed to open GLFW window`

This error is most commonly scene when attempting to run Grail on a Windows virtual machine. If your use-case is different, please open an issue with the details of your environment. As far as the project team is aware, this error can be traced to a lack of OpenGL compatibility on Windows virtual machines. This means that the issues is a driver problem that cannot be resolved until there is better OpenGL support in virtual video drivers. If you need a virtual machine, but do not need Windows, a virtual machine running Ubuntu Linux should work. Otherwise, until there is sufficient OpenGL support for virtual Windows, you will have to resort to a dual boot or alternative computer to run Grail and Grail-based programs.

Everything Else

If you have an issue not on this list, and feel it should be included on the list of frequent issues, open an issue and let us know!

Ostrich96/GrailGUI