Skip to content

Contibuting

Jump to bottom
Elliot edited this page Aug 14, 2024 · 3 revisions

All contributions are welcome here, as long as it isn't something bad.

Setting up your IDE.

If you use Visual Studio Code:

  1. Create a .vscode folder in the root of the project.
  2. Create a c_cpp_properties.json file
  3. Put something like this in it:
{
    "configurations": [
        {
            "name": "Linux",
            "includePath": [
                "${default}",
                "/usr/include/gtk-3.0",
                "/usr/include/pango-1.0",
                "/usr/include/glib-2.0",
                "/usr/lib/glib-2.0/include",
                "/usr/include/harfbuzz",
                "/usr/include/freetype2",
                "/usr/include/libpng16",
                "/usr/include/libmount",
                "/usr/include/blkid",
                "/usr/include/fribidi",
                "/usr/include/cairo",
                "/usr/include/lzo",
                "/usr/include/pixman-1",
                "/usr/include/gdk-pixbuf-2.0",
                "/usr/include/gio-unix-2.0",
                "/usr/include/cloudproviders",
                "/usr/include/atk-1.0",
                "/usr/include/at-spi2-atk/2.0",
                "/usr/include/dbus-1.0",
                "/usr/lib/dbus-1.0/include",
                "/usr/include/at-spi-2.0"
            ],
            "compilerPath": "/usr/bin/clang",
            "cStandard": "c17",
            "cppStandard": "c++14",
            "intelliSenseMode": "linux-clang-x64",
            "compilerArgs": [
                "-Wno-unused-command-line-argument"
            ]
        }
    ],
    "version": 4
}

If you don't use Vs-code, you will have to do something similar for your IDE.

Compiling

XClicker uses the meson build system, and you will need that and ninja downloaded. You will also need the dependencies which is gtk+-3.0, x11, xi and xtst (may have changed, check meson.build).

To make stuff easier, we use a Makefile. So you can compile it normally with make build, compile it as a release with make release or compile it normally and run it directly with make all.

Ui

You can use an app called Glade if you want to easily work with the ui.

Packages

Making packages is really simple with the Makefile.

Run make deb to create a deb package (you will need dpkg). Run make appimg to create an AppImage.

The aur package is here

Clone this wiki locally