• Home
Name Date Size #Lines LOC

..--

README.minimal.txtD12-May-2024754 2616

README.redistrib.txtD12-May-20244.2 KiB10586

README.standard.txtD12-May-20241.6 KiB4730

README.minimal.txt

1CONTENTS
2--------
3
4cmake       Contains CMake configuration files shared by all targets.
5
6include     Contains all required CEF header files.
7
8libcef_dll  Contains the source code for the libcef_dll_wrapper static library
9            that all applications using the CEF C++ API must link against.
10
11Release     Contains the "Chromium Embedded Framework.framework" and other
12            components required to run the release version of CEF-based
13            applications.
14
15
16USAGE
17-----
18
19Building using CMake:
20  CMake can be used to generate project files in many different formats. See
21  usage instructions at the top of the CMakeLists.txt file.
22
23Please visit the CEF Website for additional usage information.
24
25https://bitbucket.org/chromiumembedded/cef/
26

README.redistrib.txt

1REDISTRIBUTION
2--------------
3
4This binary distribution contains the below components. Components listed under
5the "required" section must be redistributed with all applications using CEF.
6Components listed under the "optional" section may be excluded if the related
7features will not be used.
8
9Applications using CEF on OS X must follow a specific app bundle structure.
10Replace "cefclient" in the below example with your application name.
11
12cefclient.app/
13  Contents/
14    Frameworks/
15      Chromium Embedded Framework.framework/
16        Chromium Embedded Framework <= main application library
17        Libraries/
18          libEGL.dylib <= angle support libraries
19          libGLESv2.dylib <=^
20          libswiftshader_libEGL.dylib <= swiftshader support libraries
21          libswiftshader_libGLESv2.dylib <=^
22        Resources/
23          chrome_100_percent.pak <= non-localized resources and strings
24          chrome_200_percent.pak <=^
25          resources.pak          <=^
26          icudtl.dat <= unicode support
27          snapshot_blob.bin, v8_context_snapshot.[x86_64|arm64].bin <= V8 initial snapshot
28          en.lproj/, ... <= locale-specific resources and strings
29          Info.plist
30      cefclient Helper.app/
31        Contents/
32          Info.plist
33          MacOS/
34            cefclient Helper <= helper executable
35          Pkginfo
36      Info.plist
37    MacOS/
38      cefclient <= cefclient application executable
39    Pkginfo
40    Resources/
41      binding.html, ... <= cefclient application resources
42
43The "Chromium Embedded Framework.framework" is an unversioned framework that
44contains CEF binaries and resources. Executables (cefclient, cefclient Helper,
45etc) must load this framework dynamically at runtime instead of linking it
46directly. See the documentation in include/wrapper/cef_library_loader.h for
47more information.
48
49The "cefclient Helper" app is used for executing separate processes (renderer,
50plugin, etc) with different characteristics. It needs to have a separate app
51bundle and Info.plist file so that, among other things, it doesn't show dock
52icons.
53
54Required components:
55
56The following components are required. CEF will not function without them.
57
58* CEF core library.
59  * Chromium Embedded Framework.framework/Chromium Embedded Framework
60
61* Unicode support data.
62  * Chromium Embedded Framework.framework/Resources/icudtl.dat
63
64* V8 snapshot data.
65  * Chromium Embedded Framework.framework/Resources/snapshot_blob.bin
66  * Chromium Embedded Framework.framework/Resources/v8_context_snapshot.bin
67
68Optional components:
69
70The following components are optional. If they are missing CEF will continue to
71run but any related functionality may become broken or disabled.
72
73* Localized resources.
74  Locale file loading can be disabled completely using
75  CefSettings.pack_loading_disabled.
76
77  * Chromium Embedded Framework.framework/Resources/*.lproj/
78    Directory containing localized resources used by CEF, Chromium and Blink. A
79    .pak file is loaded from this directory based on the CefSettings.locale
80    value. Only configured locales need to be distributed. If no locale is
81    configured the default locale of "en" will be used. Without these files
82    arbitrary Web components may display incorrectly.
83
84* Other resources.
85  Pack file loading can be disabled completely using
86  CefSettings.pack_loading_disabled.
87
88  * Chromium Embedded Framework.framework/Resources/chrome_100_percent.pak
89  * Chromium Embedded Framework.framework/Resources/chrome_200_percent.pak
90  * Chromium Embedded Framework.framework/Resources/resources.pak
91    These files contain non-localized resources used by CEF, Chromium and Blink.
92    Without these files arbitrary Web components may display incorrectly.
93
94* Angle support.
95  * Chromium Embedded Framework.framework/Libraries/libEGL.dylib
96  * Chromium Embedded Framework.framework/Libraries/libGLESv2.dylib
97  Without these files HTML5 accelerated content like 2D canvas, 3D CSS and WebGL
98  will not function.
99
100* SwiftShader support.
101  * Chromium Embedded Framework.framework/Libraries/libswiftshader_libEGL.dylib
102  * Chromium Embedded Framework.framework/Libraries/libswiftshader_libGLESv2.dylib
103  Without these files WebGL will not function in software-only mode when the GPU
104  is not available or disabled.
105

README.standard.txt

1CONTENTS
2--------
3
4cmake       Contains CMake configuration files shared by all targets.
5
6Debug       Contains the "Chromium Embedded Framework.framework" and other
7            components required to run the debug version of CEF-based
8            applications.
9
10include     Contains all required CEF header files.
11
12libcef_dll  Contains the source code for the libcef_dll_wrapper static library
13            that all applications using the CEF C++ API must link against.
14
15Release     Contains the "Chromium Embedded Framework.framework" and other
16            components required to run the release version of CEF-based
17            applications.
18
19tests/      Directory of tests that demonstrate CEF usage.
20
21  cefclient Contains the cefclient sample application configured to build
22            using the files in this distribution. This application demonstrates
23            a wide range of CEF functionalities.
24
25  cefsimple Contains the cefsimple sample application configured to build
26            using the files in this distribution. This application demonstrates
27            the minimal functionality required to create a browser window.
28
29  ceftests  Contains unit tests that exercise the CEF APIs.
30
31  gtest     Contains the Google C++ Testing Framework used by the ceftests
32            target.
33
34  shared    Contains source code shared by the cefclient and ceftests targets.
35
36
37USAGE
38-----
39
40Building using CMake:
41  CMake can be used to generate project files in many different formats. See
42  usage instructions at the top of the CMakeLists.txt file.
43
44Please visit the CEF Website for additional usage information.
45
46https://bitbucket.org/chromiumembedded/cef/
47