Skip to content

Latest commit

 

History

History
46 lines (32 loc) · 1.2 KB

INSTALL.md

File metadata and controls

46 lines (32 loc) · 1.2 KB

INSTALLATION INSTRUCTIONS

xwmfs uses autotools as a buildsystem. The following commands will build and install everything with default settings:

./bootstrap
./configure
make
make install

For successful compilation the following dependencies are required:

  • the x11 client library
  • the fuse (file system in userspace) library
  • a C++11 compatible C++ compiler

For running the file system the fuse kernel module (CONFIG_FUSE_FS) also needs to be available.

Only Linux on x86-64 has been tested by me so far.

There are currently no special configure options available for xwmfs besides the default options provided by autotools.

DEBUG BUILD

To create a debug build simply set CFLAGS and CXXFLAGS accordingly e.g.

- CFLAGS="-g -O"
- CXXFLAGS="$CFLAGS"

before running configure.

UNIT TESTS

You can build make check to run a number of unit tests shipped with xwmfs. These are written in python and run automatically without user interaction.

You can run isolated unit tests yourself by executing the appropriate scripts from the tests directory. You either need to specify the xwmfs binary as -b <BINARY> or via the XWMFS environment variable.