README.md
1OpenEmbedded/Yocto BSP layer for Firefox Browser
2================================================
3
4This layer provides web browser recipes for use with OpenEmbedded
5and/or Yocto.
6
7This layer depends on:
8
9* URI: git://git.openembedded.org/openembedded-core
10 - branch: master
11 - revision: HEAD
12
13* URI: git://git.openembedded.org/meta-openembedded
14 - layers: meta-oe
15 - branch: master
16 - revision: HEAD
17
18* URI: git://github.com/kraj/meta-clang
19 - branch: master
20 - revision: HEAD
21
22* URI: git://github.com/meta-rust/meta-rust
23 - branch: master
24 - revision: HEAD
25
26* python2.7 and python on host for HOSTTOOLS
27 - e.g. on newer ubuntu which doesn't install python2 at all by default
28 you need to install python-is-python2 (which will pull python2-minimal/python2.7-minimal)
29
30Contributing
31------------
32
33The preferred way to contribute to this layer is to send GitHub pull requests or
34report problems in GitHub's issue tracker.
35
36Alternatively there is the classic way of review on the OpenEmbedded dev mailing
37list openembedded-devel@lists.openembedded.org (you have to be subscribed to
38post to the list). Please cc the maintainers if you send your patches.
39
40Maintainers
41-----------
42* Fabio Berton <fabio.berton@ossystems.com.br>
43* Khem Raj <raj.khem@gmail.com>
44* Otavio Salvador <otavio@ossystems.com.br>
45* Takuro Ashie <ashie@clear-code.com>
46
47When sending single patches, please use something like :
48```
49git send-email -1 -s --to openembedded-devel@lists.openembedded.org --subject-prefix='meta-browser][PATCH'
50```
51
52Recipes
53-------
54recipes-browser/firefox:
55Firefox browser.
56
57This recipe provides a package for the Firefox web browser.
58
59PACKAGECONFIG knobs
60-------------------
61* alsa: (detected automatically)
62 Enable ALSA support to play audio. It will be enabled automatically when
63 DISTRO_FEATURES contains "alsa". Note that Firefox's default audio backend
64 is PulseAudio, not ALSA. Although it's not enabled in official build, we
65 enable it by default to make easy to play audio without additional daemons.
66 When PulseAudio is running, it will be used instead of using ALSA directly
67 even if this config is specified.
68
69* wayland: (detected automatically)
70 Enable wayland support. It will be enabled automatically when DISTRO_FEATURES
71 contains "wayland".
72
73* gpu: (off by default)
74 Enable GPU acceleration.
75
76* openmax: (off by default)
77 Enable OpenMAX IL decoder to play H.264 video.
78 This features is confirmed only on Renesas RZ/G1.
79
80* webgl: (off by default)
81 Firefox on Linux doesn't enable WebGL against most GPUs by default. This
82 option adds a config file to enable it focedly.
83
84* forbit-multiple-compositors: (off by default)
85 This option allows to create only one GPU accelerated compositor, second and
86 the following windows will use basic compositors. Multiple compositor may
87 cause crash on platforms that doesn't support multiple EGL windows.
88
89Runtime options
90---------------
91* The enviromental variable `GDK_BACKEND=wayland` is needed to run Firefox with
92 the wayland backend.
93