summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorCarsten Haitzler (Rasterman) <raster@rasterman.com>2019-06-20 18:06:40 +0100
committerCarsten Haitzler (Rasterman) <raster@rasterman.com>2019-06-20 18:19:30 +0100
commit7794dc984d701e4749ffb9e4a087294ff592a34d (patch)
treed9436718cc80cb2389ad1d2b9664b231a9701a29
parent215e68a370bc8f04b0a58d6a2bb07f264f746f91 (diff)
update readme in preparation for release
merge in the minimal wayland info into the README now
-rw-r--r--README42
-rw-r--r--README.wayland83
2 files changed, 31 insertions, 94 deletions
diff --git a/README b/README
index ce753d0a5..ada9dc483 100644
--- a/README
+++ b/README
@@ -1,24 +1,44 @@
1Please report bugs and send patches to phab.enlightenment.org
2
3Enlightenment 1Enlightenment
4
5Requirements:
6------------- 2-------------
7 3
4Please report bugs and submit patches at https://phab.enlightenment.org
5
6Requirements
7------------
8
8Must: 9Must:
9 efl 10 * efl
10 libc libm libX11 libXext 11 * xcb
11 xcb xcb-shape xcb-keysyms 12 * xcb-shape
13 * xcb-keysyms
14 * libpam (On Linux)
12 15
13Heavily suggested: 16Highly suggested:
14 evas_generic_loaders (all loaders) 17 * evas_generic_loaders (All loaders)
18 * bluez5 (BT support and l2ping tool)
19 * connman
20 * bc (For everything calculator)
21 * pulseaudio
22 * acpid (Unless your system doesn't have ACPI at all)
23 * packagekit (For packagekit module updates status)
24 * udisks2
25 * gdb (If you want automatic bactraces in ~/.e-crashdump.txt)
15 26
16NOTE: Users of DR16 will need to rename the $prefix/bin/enlightenment 27NOTE: Users of DR16 will need to rename the $prefix/bin/enlightenment
17file prior to installing this release or it will be overwritten. 28file prior to installing this release or it will be overwritten.
18 29
19NOTES: 30Please see the INSTALL file for now to compile and install it.
20 31
21* if you do not want security issues make sure sysactions.conf is in 32NOTE: If you do not want security issues make sure sysactions.conf is in
22/etc/enlightenment (not PREFIX/etc/enlightenment) as this is the first place 33/etc/enlightenment (not PREFIX/etc/enlightenment) as this is the first place
23it looks at. This file is intended to be customized by packagers and 34it looks at. This file is intended to be customized by packagers and
24system integrators to match your policies and scripts/tools. 35system integrators to match your policies and scripts/tools.
36
37NOTE: To enable wayland support (still considered experimental and not for
38regular end users) use the meson -Dwayland=true option. To run
39enlightenment in wayland mode, just log on on ant vt and run
40enlightenment_start. If you wish to debug and see all the output try
41using something like screen then attaching to the remote screen
42session by sshing in etc.
43
44
diff --git a/README.wayland b/README.wayland
deleted file mode 100644
index ca30ba898..000000000
--- a/README.wayland
+++ /dev/null
@@ -1,83 +0,0 @@
1*Wayland support in Enlightenment*
2
3Running Enlightenment as a Wayland compositor is not considered "safe"
4for everyday desktop use, though it is functional enough to test or
5use in specialized environments.
6A list of known issues can be found at the bottom of this file.
7
8
9Requirements:
10-------------
11
12Aside from the normal requirements that Enlightenment needs, there are
13a few things to note in order to get Enlightenment to build with
14Wayland support.
15
16Firstly, you MUST have EFL built with the following options:
17
18 --enable-drm
19 --enable-gl-drm (for hardware acceleration)
20 --enable-wayland
21 --enable-systemd
22 --enable-elput
23
24Note that the drm engine will not be functional unless the target system
25has libsystemd-login installed.
26
27This Readme does not address the dependencies needed to enable Wayland
28in EFL. If you require any information for that, please see:
29
30 https://phab.enlightenment.org/w/wayland/
31
32If you would like support for EGL in Wayland, then also build EFL with:
33
34 --enable-egl
35 --with-opengl=es
36
37The above options can be enabled for EFL without any adverse effects to
38existing applications.
39
40
41Compiling:
42-------------
43
44In order for Enlightenment to be compiled as Wayland compositor you will need to
45pass an option to the configure stage of Enlightenment:
46
47 -Dwayland=true
48
49At this stage, you should have EFL properly built, and Enlightenment
50properly built. Let's move on to running it...
51
52
53Usage:
54-------------
55
56Hopefully at this stage you have successfully built EFL and
57Enlightenment in preparation for a Wayland-supported setup. Congratulations!!
58Now, let's get it running...
59
60Enlightenment, when compiled with Wayland support and started from a tty,
61will automatically attempt to load the wl_drm output module and start
62a Wayland session. Simply start as usual:
63
64 enlightenment_start
65
66If you have a separate configuration profile that you would like to use,
67you can tell Enlightenment to use that when you start it:
68
69 enlightenment_start -profile <my_profile>
70
71To run a wayland session inside x11, export E_WL_FORCE=x11 before starting
72enlightenment.
73
74Known Issues
75-------------
76* Internal window (eg. filemanager), DnD is not currently functional
77 - Requires various improvements
78* Restarting Enlightenment kills some applications
79 - Requires upstream external protocol support, XWayland improvements
80* XWayland clients do not smoothly resize
81 - Requires upstream XWayland improvements
82* There are not more than 4 keyboard layouts possible
83 - Requires libxkbcommon changes - https://github.com/xkbcommon/libxkbcommon/issues/37