diff --git a/README.md b/README.md index 54d606f68..7ae3260e4 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ The Chromium Embedded Framework (CEF) is a simple framework for embedding Chromium-based browsers in other applications. -# Quick Links # +# Quick Links * Tutorial - https://bitbucket.org/chromiumembedded/cef/wiki/Tutorial * General Usage - https://bitbucket.org/chromiumembedded/cef/wiki/GeneralUsage @@ -10,7 +10,8 @@ The Chromium Embedded Framework (CEF) is a simple framework for embedding Chromi * CEF3 C++ API Docs - http://magpcss.org/ceforum/apidocs3/ * Downloads - http://www.magpcss.net/cef_downloads/ and http://cefbuilds.com (automated nightly builds) * Donations - http://www.magpcss.org/ceforum/donate.php -# Introduction # + +# Introduction CEF is a BSD-licensed open source project founded by Marshall Greenblatt in 2008 and based on the [Google Chromium](http://www.chromium.org/Home) project. Unlike the Chromium project itself, which focuses mainly on Google Chrome application development, CEF focuses on facilitating embedded browser use cases in third-party applications. CEF insulates the user from the underlying Chromium and Blink code complexity by offering production-quality stable APIs, release branches tracking specific Chromium releases, and binary distributions. Most features in CEF have default implementations that provide rich functionality while requiring little or no integration work from the user. There are currently over 100 million installed instances of CEF around the world embedded in products from a wide range of companies and industries. A partial list of companies and products using CEF is available on the [CEF Wikipedia page](http://en.wikipedia.org/wiki/Chromium_Embedded_Framework#Applications_using_CEF). Some use cases for CEF include: @@ -21,21 +22,21 @@ CEF is a BSD-licensed open source project founded by Marshall Greenblatt in 2008 CEF supports a wide range of programming languages and operating systems and can be easily integrated into both new and existing applications. It was designed from the ground up with both performance and ease of use in mind. The base framework includes C and C++ programming interfaces exposed via native libraries that insulate the host application from Chromium and Blink implementation details. It provides close integration between the browser and the host application including support for custom plugins, protocols, JavaScript objects and JavaScript extensions. The host application can optionally control resource loading, navigation, context menus, printing and more, while taking advantage of the same performance and HTML5 technologies available in the Google Chrome Web browser. -Users new to CEF development should start by reading the [Tutorial](Tutorial.md) Wiki page for an overview of CEF usage and then proceed to the [GeneralUsage](GeneralUsage.md) Wiki page for a more in-depth discussion or architectural and usage issues. Complete API documentation is available [here](http://magpcss.org/ceforum/apidocs3/). CEF support and related discussion is available on the [CEF Forum](http://www.magpcss.org/ceforum/). +Users new to CEF development should start by reading the [Tutorial](https://bitbucket.org/chromiumembedded/cef/wiki/Tutorial) Wiki page for an overview of CEF usage and then proceed to the [GeneralUsage](https://bitbucket.org/chromiumembedded/cef/wiki/GeneralUsage) Wiki page for a more in-depth discussion or architectural and usage issues. Complete API documentation is available [here](http://magpcss.org/ceforum/apidocs3/). CEF support and related discussion is available on the [CEF Forum](http://www.magpcss.org/ceforum/). Numerous individuals and organizations contribute time and resources to support CEF development, but more involvement from the community is always welcome. This includes support for both the core CEF project and external projects that integrate CEF with additional programming languages and frameworks (see the "External Projects" section below). If you are interested in donating time to help with CEF development please see the "Helping Out" section below. If you are interested in donating money to support general CEF development and infrastructure efforts please visit the [CEF Donations](http://www.magpcss.org/ceforum/donate.php) page. -# Binary Distributions # +# Binary Distributions Binary distributions, which include all files necessary to build a CEF-based application, are available on the [Downloads](http://www.magpcss.net/cef_downloads/) page. Automated nightly builds, available from http://cefbuilds.com, include the newest changes but may not be fully tested. Binary distributions are stand-alone and do not require the download of CEF or Chromium source code. Symbol files for debugging binary distributions of libcef can also be downloaded from the above links. -Release notes for past and current CEF binary distributions are available [here](ReleaseNotes.md). +Release notes for past and current CEF binary distributions are available [here](https://bitbucket.org/chromiumembedded/cef/wiki/ReleaseNotes). -# Source Distributions # +# Source Distributions -The CEF project is an extension of the Chromium project. CEF maintains development and release branches that track Chromium branches. CEF source code can be downloaded, built and packaged manually or with automated tools. Visit the [BranchesAndBuilding](BranchesAndBuilding.md) Wiki page for more information. +The CEF project is an extension of the Chromium project. CEF maintains development and release branches that track Chromium branches. CEF source code can be downloaded, built and packaged manually or with automated tools. Visit the [BranchesAndBuilding](https://bitbucket.org/chromiumembedded/cef/wiki/BranchesAndBuilding) Wiki page for more information. -# External Projects # +# External Projects The base CEF framework includes support for the C and C++ programming languages. Thanks to the hard work of external maintainers CEF can integrate with a number of other programming languages and frameworks. These external projects are not maintained by CEF so please contact the respective project maintainer if you have any questions or issues. @@ -52,7 +53,7 @@ The base CEF framework includes support for the C and C++ programming languages. If you're the maintainer of a project not listed above and would like your project listed here please either post to the [CEF Forum](http://www.magpcss.org/ceforum/) or contact Marshall directly. -# Helping Out # +# Helping Out CEF is still very much a work in progress. Some ways that you can help out: @@ -78,4 +79,4 @@ If you would like to contribute source code changes to CEF please follow the bel * Be submitted against the current [CEF master branch](https://bitbucket.org/chromiumembedded/cef/src/?at=master) unless explicitly fixing a bug in a CEF release branch. * Follow the style of existing CEF source files. In general CEF uses the [Chromium coding style](http://www.chromium.org/developers/coding-style). * Include new or modified unit tests as appropriate to the functionality. -* Not include unnecessary or unrelated changes. +* Not include unnecessary or unrelated changes. \ No newline at end of file