Evolinx/sddm
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Move and update the INSTALL file.

Browse Source
This commit is contained in:
Jerome Leclanche 2014-08-02 15:41:22 +01:00
parent b920a29a34
commit d826b56185
2 changed files with 35 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
INSTALL Normal file
View File

@ -0,0 +1,35 @@
## Installation instructions
SDDM uses CMake to configure and build the project.
1. From the project root, create a build directory: `mkdir build`
2. From the build directory, run cmake to the project root. Eg: `cd build && cmake ..`
3. To build, run `make`.
4. To install, run `make install`.
CMake accepts a number of standard and extra arguments. For example, to build
with Qt 5, append the argument `-DUSE_QT5=true`.
By default, a debug build is created. To build for production, use
`cmake -DCMAKE_BUILD_TYPE=Release`.
To see all the possible arguments, run `cmake -L ..`.
For documentation on standard CMake variables, see:
http://www.cmake.org/cmake/help/v3.0/manual/cmake-variables.7.html
### Post-installation steps
By default, SDDM runs as its own user. An `sddm` user needs to be created, with
its home set to `/var/lib/sddm` by default.
### Dependencies
SDDM depends on PAM for authorization and XCB to communicate with the X server.
Apart from other things, it also depends on Qt for the user interface and event
loop management.
SDDM can optionally make use of logind (the systemd login manager API) or
upower to enable support for suspend, hibernate etc.
In order to build the man pages, you will need `rst2man` installed. It is
provided by the python `docutils` package
Note that SDDM makes use of C++11 features for a modern and clean codebase,
therefore it needs a recent version of GCC to compile (4.7 at least).

30
docs/INSTALL.md
View File

@ -1,30 +0,0 @@
## Dependencies
SDDM depends on PAM for authorization and XCB to communicate with the X server. Apart from other things, it also depends on Qt for the user interface and event loop management. SDDM can optionally make use of systemd's login manager (logind) or upower to enable support for suspend, hibernate etc.
## Compilation
SDDM uses CMake to configure the build and it can be compiled with the typical cmake build process:
`mkdir build`
`cd build`
`cmake .. -DCMAKE_INSTALL_PREFIX=/usr/local`
`make`
After successfully building the software, install it:
`sudo make install`
If systemd is found during the build, it will be used for power management. Otherwise, the build will fallback to upower. If upower can't be found either, shutdown/reboot/suspend/hibernate actions won't be available.
Note that, when systemd is used, the HaltCommand and RebootCommand config file entries have no effect.
SDDM by default uses Qt4. If you want to use Qt5 instead, simply add `-DUSE_QT5=true` at the end of the cmake line. Qt5 unlocks some additional capabilities for the themes like hardware acceleration, mouse cursors etc.
Note that SDDM uses certain C++11 features for a modern and clean codebase, therefore it needs `gcc >= 4.7` to compile.
## Configuration
After installation, the file `sddm.conf` can be used to configure sddm. Options in the config file are mostly self explanatory, but the sample config file, by default named `sddm.conf.sample` can also be used as a reference as it contains comments for each individual option.