update readme in preparation for release
merge in the minimal wayland info into the README now
This commit is contained in:
parent
215e68a370
commit
7794dc984d
44
README
44
README
|
|
@ -1,24 +1,44 @@
|
||||||
Please report bugs and send patches to phab.enlightenment.org
|
|
||||||
|
|
||||||
Enlightenment
|
Enlightenment
|
||||||
|
|
||||||
Requirements:
|
|
||||||
-------------
|
-------------
|
||||||
|
|
||||||
Must:
|
Please report bugs and submit patches at https://phab.enlightenment.org
|
||||||
efl
|
|
||||||
libc libm libX11 libXext
|
|
||||||
xcb xcb-shape xcb-keysyms
|
|
||||||
|
|
||||||
Heavily suggested:
|
Requirements
|
||||||
evas_generic_loaders (all loaders)
|
------------
|
||||||
|
|
||||||
|
Must:
|
||||||
|
* efl
|
||||||
|
* xcb
|
||||||
|
* xcb-shape
|
||||||
|
* xcb-keysyms
|
||||||
|
* libpam (On Linux)
|
||||||
|
|
||||||
|
Highly suggested:
|
||||||
|
* evas_generic_loaders (All loaders)
|
||||||
|
* bluez5 (BT support and l2ping tool)
|
||||||
|
* connman
|
||||||
|
* bc (For everything calculator)
|
||||||
|
* pulseaudio
|
||||||
|
* acpid (Unless your system doesn't have ACPI at all)
|
||||||
|
* packagekit (For packagekit module updates status)
|
||||||
|
* udisks2
|
||||||
|
* gdb (If you want automatic bactraces in ~/.e-crashdump.txt)
|
||||||
|
|
||||||
NOTE: Users of DR16 will need to rename the $prefix/bin/enlightenment
|
NOTE: Users of DR16 will need to rename the $prefix/bin/enlightenment
|
||||||
file prior to installing this release or it will be overwritten.
|
file prior to installing this release or it will be overwritten.
|
||||||
|
|
||||||
NOTES:
|
Please see the INSTALL file for now to compile and install it.
|
||||||
|
|
||||||
* if you do not want security issues make sure sysactions.conf is in
|
NOTE: If you do not want security issues make sure sysactions.conf is in
|
||||||
/etc/enlightenment (not PREFIX/etc/enlightenment) as this is the first place
|
/etc/enlightenment (not PREFIX/etc/enlightenment) as this is the first place
|
||||||
it looks at. This file is intended to be customized by packagers and
|
it looks at. This file is intended to be customized by packagers and
|
||||||
system integrators to match your policies and scripts/tools.
|
system integrators to match your policies and scripts/tools.
|
||||||
|
|
||||||
|
NOTE: To enable wayland support (still considered experimental and not for
|
||||||
|
regular end users) use the meson -Dwayland=true option. To run
|
||||||
|
enlightenment in wayland mode, just log on on ant vt and run
|
||||||
|
enlightenment_start. If you wish to debug and see all the output try
|
||||||
|
using something like screen then attaching to the remote screen
|
||||||
|
session by sshing in etc.
|
||||||
|
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,83 +0,0 @@
|
||||||
*Wayland support in Enlightenment*
|
|
||||||
|
|
||||||
Running Enlightenment as a Wayland compositor is not considered "safe"
|
|
||||||
for everyday desktop use, though it is functional enough to test or
|
|
||||||
use in specialized environments.
|
|
||||||
A list of known issues can be found at the bottom of this file.
|
|
||||||
|
|
||||||
|
|
||||||
Requirements:
|
|
||||||
-------------
|
|
||||||
|
|
||||||
Aside from the normal requirements that Enlightenment needs, there are
|
|
||||||
a few things to note in order to get Enlightenment to build with
|
|
||||||
Wayland support.
|
|
||||||
|
|
||||||
Firstly, you MUST have EFL built with the following options:
|
|
||||||
|
|
||||||
--enable-drm
|
|
||||||
--enable-gl-drm (for hardware acceleration)
|
|
||||||
--enable-wayland
|
|
||||||
--enable-systemd
|
|
||||||
--enable-elput
|
|
||||||
|
|
||||||
Note that the drm engine will not be functional unless the target system
|
|
||||||
has libsystemd-login installed.
|
|
||||||
|
|
||||||
This Readme does not address the dependencies needed to enable Wayland
|
|
||||||
in EFL. If you require any information for that, please see:
|
|
||||||
|
|
||||||
https://phab.enlightenment.org/w/wayland/
|
|
||||||
|
|
||||||
If you would like support for EGL in Wayland, then also build EFL with:
|
|
||||||
|
|
||||||
--enable-egl
|
|
||||||
--with-opengl=es
|
|
||||||
|
|
||||||
The above options can be enabled for EFL without any adverse effects to
|
|
||||||
existing applications.
|
|
||||||
|
|
||||||
|
|
||||||
Compiling:
|
|
||||||
-------------
|
|
||||||
|
|
||||||
In order for Enlightenment to be compiled as Wayland compositor you will need to
|
|
||||||
pass an option to the configure stage of Enlightenment:
|
|
||||||
|
|
||||||
-Dwayland=true
|
|
||||||
|
|
||||||
At this stage, you should have EFL properly built, and Enlightenment
|
|
||||||
properly built. Let's move on to running it...
|
|
||||||
|
|
||||||
|
|
||||||
Usage:
|
|
||||||
-------------
|
|
||||||
|
|
||||||
Hopefully at this stage you have successfully built EFL and
|
|
||||||
Enlightenment in preparation for a Wayland-supported setup. Congratulations!!
|
|
||||||
Now, let's get it running...
|
|
||||||
|
|
||||||
Enlightenment, when compiled with Wayland support and started from a tty,
|
|
||||||
will automatically attempt to load the wl_drm output module and start
|
|
||||||
a Wayland session. Simply start as usual:
|
|
||||||
|
|
||||||
enlightenment_start
|
|
||||||
|
|
||||||
If you have a separate configuration profile that you would like to use,
|
|
||||||
you can tell Enlightenment to use that when you start it:
|
|
||||||
|
|
||||||
enlightenment_start -profile <my_profile>
|
|
||||||
|
|
||||||
To run a wayland session inside x11, export E_WL_FORCE=x11 before starting
|
|
||||||
enlightenment.
|
|
||||||
|
|
||||||
Known Issues
|
|
||||||
-------------
|
|
||||||
* Internal window (eg. filemanager), DnD is not currently functional
|
|
||||||
- Requires various improvements
|
|
||||||
* Restarting Enlightenment kills some applications
|
|
||||||
- Requires upstream external protocol support, XWayland improvements
|
|
||||||
* XWayland clients do not smoothly resize
|
|
||||||
- Requires upstream XWayland improvements
|
|
||||||
* There are not more than 4 keyboard layouts possible
|
|
||||||
- Requires libxkbcommon changes - https://github.com/xkbcommon/libxkbcommon/issues/37
|
|
||||||
Loading…
Reference in New Issue