Readme.txt 4.2 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061
  1. CefSharp Nuget Package
  2. Background:
  3. CefSharp is a .Net wrapping library for CEF (Chromium Embedded Framework) https://bitbucket.org/chromiumembedded/cef
  4. CEF is a C/C++ library that allows developers to embed the HTML content rendering strengths of Google's Chrome open source WebKit engine (Chromium).
  5. Post Installation:
  6. - Read the release notes for your version https://github.com/cefsharp/CefSharp/releases (Any known issues will be listed here)
  7. - Read the `Need to know/limitations` section of the General usage guide (https://github.com/cefsharp/CefSharp/wiki/General-Usage#need-to-knowlimitations)
  8. - For `x86` or x64` set your projects PlatformTarget architecture to `x86` or `x64`.
  9. - `AnyCPU` target is supported though requires additional code/changes see https://github.com/cefsharp/CefSharp/issues/1714 for details.
  10. - Check your output `\bin` directory to make sure the appropriate references have been copied.
  11. - Add an app.manifest to your exe if you don't already have one, it's required for Windows 10 compatability, HighDPI support and tooltips. The https://github.com/cefsharp/CefSharp.MinimalExample project contains an example app.manifest file in the root of the WPF/WinForms/OffScreen examples.
  12. Deployment:
  13. - Make sure a minimum of `Visual C++ 2019` is installed (`x86` or x64` depending on your build) or package the runtime dlls with your application, see the FAQ for details.
  14. What's New:
  15. See https://github.com/cefsharp/CefSharp/wiki/ChangeLog
  16. IMPORTANT NOTE - Visual C++ 2019 is now required
  17. IMPORTANT NOTE - .NET Framework 4.5.2 is now required.
  18. IMPORTANT NOTE - Chromium has removed support for Windows XP/2003 and Windows Vista/Server 2008 (non R2).
  19. Basic Troubleshooting:
  20. - Minimum of .Net 4.5.2
  21. - Minimum of `Visual C++ 2019 Redist` is installed (either `x86` or `x64` depending on your application).
  22. - Please ensure your binaries directory contains these required dependencies:
  23. * libcef.dll (Chromium Embedded Framework Core library)
  24. * icudtl.dat (Unicode Support data)
  25. * chrome_elf.dll(Crash reporting library)
  26. * snapshot_blob.bin, v8_context_snapshot.bin (V8 snapshot data)
  27. * locales\en-US.pak, chrome_100_percent.pak, chrome_200_percent.pak, resources.pak, d3dcompiler_47.dll, libEGL.dll, libGLESv2.dll, swiftshader/libEGL.dll, swiftshader/libGLESv2.dll
  28. - Whilst these are technically listed as optional, the browser is unlikely to function without these files.
  29. - See https://github.com/cefsharp/CefSharp/wiki/Output-files-description-table-%28Redistribution%29 for details
  30. * CefSharp.Core.dll, CefSharp.dll, CefSharp.Core.Runtime.dll
  31. CefSharp.BrowserSubprocess.exe, CefSharp.BrowserSubProcess.Core.dll
  32. - These are required CefSharp binaries that are the common core logic binaries of CefSharp.
  33. * One of the following UI presentation libraries:
  34. * CefSharp.WinForms.dll
  35. * CefSharp.Wpf.dll
  36. * CefSharp.OffScreen.dll
  37. - Additional CEF files are described at: https://github.com/cefsharp/CefSharp/wiki/Output-files-description-table-%28Redistribution%29
  38. - NOTE: CefSharp does not currently support CEF sandboxing.
  39. - By default `CEF` has it's own log file, `Debug.log` which is located in your executing folder. e.g. `bin`
  40. For further help please read the following content:
  41. - General Usage Guide https://github.com/cefsharp/CefSharp/wiki/General-Usage
  42. - Minimal Example Projects showing the browser in action (https://github.com/cefsharp/CefSharp.MinimalExample)
  43. - CefSharp GitHub https://github.com/cefsharp/CefSharp
  44. - CefSharp's Wiki on github (https://github.com/cefsharp/CefSharp/wiki)
  45. - FAQ: https://github.com/cefsharp/CefSharp/wiki/Frequently-asked-questions
  46. - Troubleshooting guide (https://github.com/cefsharp/CefSharp/wiki/Trouble-Shooting)
  47. - Google Groups (https://groups.google.com/forum/#!forum/cefsharp) - Historic reference only
  48. - CefSharp vs Cef (https://github.com/cefsharp/CefSharp/blob/master/CONTRIBUTING.md#cefsharp-vs-cef)
  49. - Join the active community and ask your question on Gitter Chat (https://gitter.im/cefsharp/CefSharp)
  50. - If you have a reproducible bug then please open an issue on `GitHub`
  51. Please consider giving back, it's only with your help will this project to continue.
  52. Regards,
  53. CefSharp Team