Skip to content

Latest commit

 

History

History
76 lines (50 loc) · 2.23 KB

README.md

File metadata and controls

76 lines (50 loc) · 2.23 KB

Development

Clone the project

Note : you should have git and git-lfs installed.

git clone --recursive https://gitlab.com/squey/squey.git

Development shell

Note : you should have python installed.

cd squey/buildstream && ./dev_shell.sh

From then you can choose to use the development shell to compile and run the software as such:

cd builds/{Clang,GCC}/{Debug,RelWithDebInfo} && cmake --build . && ./squey.sh

or you can continue to configure an IDE.

Configure Visual Studio Code

Install the following extensions :

  1. C/C++ Extension Pack
  2. CMake
  3. Remote Development
  4. CodeLLDB

The dev_shell.sh script is embedding a local SSH server as well as a waypipe tunnel that permit to debug the GUI application inside BuildStream development sandbox under Wayland. So don't forget to have it running to be able to open the project in vscode :

cd squey/buildstream && ./dev_shell.sh

Just append the preconfigured SSH host configuration to your local SSH configuration file:

cat buildstream/sshd/ssh_config.squey | tee -a ~/.ssh/config

Then use the vscode Remote Explorer extension to connect to the Squey hostname using a ssh key (note: password login is not supported).

Remote Explorer Open folder
CodeLLDB

Flatpak

Generating and installing a local flatpak package

cd buildstream && ./build.sh --flatpak-export=true --flatpak-repo=local_repo

Adding the flatpak local remote (once):

flatpak --user remote-add --no-gpg-verify squey_local ./local_repo

Installing a local package:

flatpak install --user squey_local org.squey.Squey//main