Skip to content
master
Switch branches/tags
Code

Cog

Cog (boat)

Build - Native Build - ARM Code Style

Cog is a small single “window” launcher for the WebKit WPE port. It is small, provides no user interface, and is suitable to be used as a Web application container. The “window” may be fullscreen depending on the WPE backend being used.

This project provides the following components:

  • libcogcore is a library with ready-to-use components typically needed for implementing applications which use the WPE WebKit API.

  • cog is the launcher itself, implemented using the libcogcore library.

  • cogctl is a tool which can be used to control a cog instance using the D-Bus session bus.

It is possible to disable building the cog and cogctl programs by passing -DCOG_BUILD_PROGRAMS=OFF to CMake.

Dependencies

Stable releases have the following dependencies:

  • WPE WebKit 2.24.x
  • libwpe 1.8.x
  • WPEBackend-fdo 1.8.x (optional, recommended)

Note that building from the master branch will often require development releases of WPE WebKit, libwpe, and WPEBackend-fdo; while older Cog releases may have different version requirements.

Using Cog

Compiling Cog follows the usual procedure for projects which use CMake: cmake . && make should get you started, if your system has the needed dependencies installed.

Documentation is available at igalia.github.io/cog but it is currently incomplete. Contributions in this regard are very welcome.

Bug tracking: If you have found a bug, take a look at out issue tracker. Please see the “reporting bugs” section in the CONTRIBUTING.md file for guidelines on how to provide a good bug report.

Contributing

For information on how to report bugs, or how to contribute to Cog, please check the CONTRIBUTING.md file.

License

This project is licensed under the terms of the MIT license. Check the COPYING file for details.