Readme.txt 3.7 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556
  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++ 2015` 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++ 2015 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++ 2015 Redist` is installed (either `x86` or `x64` depending on your application). VC++ 2017/2019 are backwards compatible.
  22. - Please ensure your binaries directory contains these required dependencies:
  23. * libcef.dll (CEF code)
  24. * icudtl.dat (Unicode Support data)
  25. * CefSharp.Core.dll, CefSharp.dll,
  26. CefSharp.BrowserSubprocess.exe, CefSharp.BrowserSubProcess.Core.dll
  27. - These are required CefSharp binaries that are the common core logic binaries of CefSharp.
  28. * One of the following UI presentation approaches:
  29. * CefSharp.WinForms.dll
  30. * CefSharp.Wpf.dll
  31. * CefSharp.OffScreen.dll
  32. - Additional optional CEF files are described at: https://github.com/cefsharp/cef-binary/blob/master/README.txt#L82
  33. NOTE: CefSharp does not currently support CEF sandboxing.
  34. - By default `CEF` has it's own log file, `Debug.log` which is located in your executing folder. e.g. `bin`
  35. For further help please read the following content:
  36. - General Usage Guide https://github.com/cefsharp/CefSharp/wiki/General-Usage
  37. - Minimal Example Projects showing the browser in action (https://github.com/cefsharp/CefSharp.MinimalExample)
  38. - CefSharp GitHub https://github.com/cefsharp/CefSharp
  39. - CefSharp's Wiki on github (https://github.com/cefsharp/CefSharp/wiki)
  40. - FAQ: https://github.com/cefsharp/CefSharp/wiki/Frequently-asked-questions
  41. - Troubleshooting guide (https://github.com/cefsharp/CefSharp/wiki/Trouble-Shooting)
  42. - Google Groups (https://groups.google.com/forum/#!forum/cefsharp) - Historic reference only
  43. - CefSharp vs Cef (https://github.com/cefsharp/CefSharp/blob/master/CONTRIBUTING.md#cefsharp-vs-cef)
  44. - Join the active community and ask your question on Gitter Chat (https://gitter.im/cefsharp/CefSharp)
  45. - If you have a reproducible bug then please open an issue on `GitHub`
  46. Please consider giving back, it's only with your help will this project to continue.
  47. Regards,
  48. CefSharp Team