Nuclear is a shell plugin for Weston. It implements a custom protocol to synchronize with a shell client such as Orbital, but does not carry a client itself, and serves no purpose without one.

Nuclear depends only on Weston 1.4 aside the toolchain to build it, that is a C++11 compiler and CMake.

To build it run these commands from the repository root directory:

mkdir build
cd build
cmake ..
make
sudo make install

Nuclear will be installed in the "/usr/local" prefix, unless you specified otherwise using the CMAKE_INSTALL_PREFIX variable:

cmake -DCMAKE_INSTALL_PREFIX=/my/prefix ..

Running make install will install the nuclear-shell.so plugin in $prefix/lib/nuclear-shell, the protocol file nuclear-desktop-shell.xml in $prefix/share/nuclear-shell and the pkg-config file nuclear.pc in $prefix/lib/pkgconfig.