diff options
| author | Chad Versace <chad.versace@linux.intel.com> | 2014-07-30 19:26:32 -0700 |
|---|---|---|
| committer | Chad Versace <chad.versace@linux.intel.com> | 2014-07-30 19:26:32 -0700 |
| commit | 1ed60d0639ee3d33b9c1b542b021cfaf67d24125 (patch) | |
| tree | 42dee87a68b111936893a09e117cb3832a15ad20 | |
| parent | a643da08399cf2a8fcbe2d4649246154f2e4d49c (diff) | |
| download | waffle-1ed60d0639ee3d33b9c1b542b021cfaf67d24125.tar.gz | |
README: Update the build instructions
The build instructions had several issues:
- They referred to a non-existent file, '/doc/building.txt'.
- They instructed the user to explicitly enable support for every
desired platform. But Waffle's CMake can now autodetect that.
Reported-by: Emil Velikov <emil.l.velikov@gmail.com>
| -rw-r--r-- | README.txt | 48 |
1 files changed, 23 insertions, 25 deletions
@@ -97,12 +97,8 @@ a comman-separated list of any combination of "x11", "wayland", and "drm". - Debian: apt-get install libgbm-dev libudev-dev -Installing -========== - -For full details on configuring, building, and installing Waffle, see -/doc/building.txt. What follows is a quick how-to. - +Build and Installation +====================== 0. Be in the correct directory ------------------------------ @@ -127,31 +123,33 @@ a dependeny into /usr/local, then: 2. Configure CMake ------------------ -On Linux, you likely want to call cmake with the following -arguments. It configures Waffle in debug mode and with support for only GLX. +On Linux and Mac, running CMake with no arguments as below will configure +Waffle for a release build (optimized compiler flags and basic debug symbols) +and will auto-enable support for features whose dependencies are installed: + + cmake . - cmake \ - -DCMAKE_BUILD_TYPE=debug \ - -Dwaffle_has_glx=1 \ - . +To manually control the configuration process, or to later modify the an already-configured source tree, +run one of the following: -If in addition to GLX you want support for X11/EGL, then add --Dwaffle_has_x11_egl=1 to the cmake arguments. Likewise for Wayland, add --Dwaffle_has_wayland=1; and for GBM, add -Dwaffle_has_gbm=1. + # An ncurses interface to CMake configuration. + ccamke $BUILD_DIR -For the full list of Waffle's custom CMake options, see file `Options.cmake`. + # A graphical Qt interface to CMake configuration. + cmake-gui $BUILD_DIR -To install into a custom location, autoconf-esque variables such -as CMAKE_INSTALL_LIBDIR are supported. See -$waffle_top/cmake/Modules/GNUInstallDirs.cmake for details. For example, to -install libwaffle into $HOME/lib, use the following cmake invocation: + # Edit the raw configuration file. + vim $BUILD_DIR/CMakeCache.txt - cmake \ - -DCMAKE_INSTALL_PREFIX=$HOME \ - -DCMAKE_INSTALL_LIBDIR=lib \ - -Dwaffle_has_glx=1 \ - . +All configuration options can also be set on the command line during the +*initial* invocation of cmake. For example, to configure Waffle for a debug +build, require support for Wayland, and install into '/usr' instead of +'/usr/local', run the following: + cmake -DCMAKE_BUILD_TYPE=Debug \ + -DCMAKE_INSTALL_PREFIX=/usr/local \ + -Dwaffle_has_wayland=1 \ + . 3. Build and Install -------------------- |