Skip to content

Commit

Permalink
Fix links in docs/ and in README again
Browse files Browse the repository at this point in the history
  • Loading branch information
cztomczak committed Mar 16, 2017
1 parent 6640ed2 commit 41fa14f
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 47 deletions.
44 changes: 18 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,12 @@ Table of contents:

## Introduction

CEF Python is a BSD-licensed open source project founded by [Czarek Tomczak]
(http://www.linkedin.com/in/czarektomczak) in 2012 and is based on
Google Chromium and the [CEF Framework]
(https://bitbucket.org/chromiumembedded/cef) projects. The Chromium
project focuses mainly on Google Chrome application development, while
CEF focuses on facilitating embedded browser use cases in third-party
applications. Lots of applications use CEF control, there are more than
[100 million CEF instances]
(http://en.wikipedia.org/wiki/Chromium_Embedded_Framework#Applications_using_CEF)
CEF Python is a BSD-licensed open source project founded by [Czarek Tomczak](http://www.linkedin.com/in/czarektomczak)
in 2012 and is based on Google Chromium and the [CEF Framework](https://bitbucket.org/chromiumembedded/cef)
projects. The Chromium project focuses mainly on Google Chrome application
development, while CEF focuses on facilitating embedded browser use cases
in third-party applications. Lots of applications use CEF control, there are
more than [100 million CEF instances](http://en.wikipedia.org/wiki/Chromium_Embedded_Framework#Applications_using_CEF)
installed around the world. [Examples of embedding](examples/Examples-README.md)
Chrome browser are available for many popular GUI toolkits including:
wxPython, PyGTK, PyQt, PySide, Kivy, Panda3D and PyGame/PyOpenGL.
Expand All @@ -33,22 +30,20 @@ There are many use cases for CEF. You can embed a web browser control
based on Chromium with great HTML 5 support. You can use it to create
a HTML 5 based GUI in an application, this can act as a replacement for
standard GUI toolkits such as wxWidgets, Qt or GTK. In such case to
communicate between Python<>Javascript use [javascript bindings]
(api/JavascriptBindings.md) or embed an internal web server and talk
using http requests. You can render web content off-screen in
applications that use custom drawing frameworks. You can use it for
automated testing of existing applications. You can use it for web
scraping or as a web crawler, or other kind of internet bots.
communicate between Python<>Javascript use [javascript bindings](api/JavascriptBindings.md)
or embed an internal web server and talk using http requests. You
can render web content off-screen in applications that use custom
drawing frameworks. You can use it for automated testing of existing
applications. You can use it for web scraping or as a web crawler,
or other kind of internet bots.


## Support

- Ask questions, report problems and issues on the [Forum]
(https://groups.google.com/group/cefpython)
- Ask questions, report problems and issues on the [Forum](https://groups.google.com/group/cefpython)
- Documentation is in the [docs/](docs) directory
- API reference is in the [api/](api) directory
- Additional documentation is in issues labelled [Knowledge Base]
(../../issues?q=is%3Aissue+is%3Aopen+label%3A%22Knowledge+Base%22)
- Additional documentation is in issues labelled [Knowledge Base](../../issues?q=is%3Aissue+is%3Aopen+label%3A%22Knowledge+Base%22)
- Wiki pages are deprecated and for v31 only


Expand All @@ -66,8 +61,7 @@ scraping or as a web crawler, or other kind of internet bots.
(requirements: MacOS 10.9+)
- Documentation is in the [docs/](docs) directory
- API reference is in the [api/](api) directory
- Additional documentation is in issues labelled [Knowledge Base]
(../../issues?q=is%3Aissue+is%3Aopen+label%3A%22Knowledge+Base%22)
- Additional documentation is in issues labelled [Knowledge Base](../../issues?q=is%3Aissue+is%3Aopen+label%3A%22Knowledge+Base%22)

### v31 release

Expand All @@ -78,8 +72,7 @@ scraping or as a web crawler, or other kind of internet bots.
- Linux support: 32-bit and 64-bit (requirements: Debian 7+ / Ubuntu 12.04+)
- Mac support: 32-bit and 64-bit (requirements: MacOS 10.7+)
- Documentation is on [wiki pages](../../wiki)
- API reference is available in revision [169a1b2]
(../../tree/169a1b20d3cd09879070d41aab28cfa195d2a7d5/docs/api)
- API reference is available in revision [169a1b2](../../tree/169a1b20d3cd09879070d41aab28cfa195d2a7d5/docs/api)


## Support development
Expand All @@ -105,9 +98,8 @@ directly.
the v55/v56 releases for all platforms
* Thanks to JetBrains for providing an Open Source license for
[PyCharm](https://www.jetbrains.com/pycharm/)
* Thanks to those who have made a Paypal donation: [Rentouch GmbH]
(http://www.rentouch.ch/), Walter Purvis, Rokas Stupuras, Alex Rattray,
Greg Kacy, Paul Korzhyk
* Thanks to those who have made a Paypal donation: [Rentouch GmbH](http://www.rentouch.ch/),
Walter Purvis, Rokas Stupuras, Alex Rattray, Greg Kacy, Paul Korzhyk
* Lots of thanks goes to [Cyan Inc.](http://www.blueplanet.com/) for
sponsoring this project for a long time, making CEF Python 3 mature
* Thanks to those who have donated their time through code contributions,
Expand Down
6 changes: 2 additions & 4 deletions docs/Build-instructions.md
Original file line number Diff line number Diff line change
Expand Up @@ -163,8 +163,7 @@ requirements common for all platforms.
if does not exist
* For Python 3.4 follow the instructions for installing Windows SDK 7.1.
If you encounter issue with .NET Framework 4 then make registry edits
as suggested here: [Windows SDK setup failure]
(http://stackoverflow.com/a/33260090/623622).
as suggested here: [Windows SDK setup failure](http://stackoverflow.com/a/33260090/623622).
* For Python 3.4, if getting error:
`Cannot open include file 'ammintrin.h': No such file or directory`
then Copy that `ammitrin.h` file from for example VS 2015 installation
Expand Down Expand Up @@ -336,8 +335,7 @@ __Debug_GN_arm/ configuration error (Linux)__: Even though building
on Linux for Linux, Chromium still runs ARM configuration files. If
there is an error showing that pkg-config fails with GTK 3 library
then see solution in the third post in this topic on CEF Forum:
[Debug_GN_arm error when building on Linux, *not* arm]
(https://magpcss.org/ceforum/viewtopic.php?f=6&t=14976).
[Debug_GN_arm error when building on Linux, *not* arm](https://magpcss.org/ceforum/viewtopic.php?f=6&t=14976).

__MISSING PACKAGES (Linux)__: After the chromium sources are downloaded,
it will try to build cef projects and if it fails due to missing packages
Expand Down
27 changes: 10 additions & 17 deletions docs/Knowledge-Base.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,9 @@ Table of contents:

## Notifications on new releases

To be notified of new releases subscribe to this [RSS/Atom feed]
(../../../releases.atom).
To be notified of new releases subscribe to this [RSS/Atom feed](../../../releases.atom).

Announcements are also made on the [Forum]
(https://groups.google.com/d/forum/cefpython).
Announcements are also made on the [Forum](https://groups.google.com/d/forum/cefpython).
To be notified of these via email set your Membership and Email settings
and change delivery preference to Daily summaries.

Expand All @@ -33,8 +31,8 @@ and change delivery preference to Daily summaries.
CEF Python depends on CEF and API breaks are inevitable when updating
to latest CEF. The [Migration Guide](Migration-guide.md) document which
is still under works, will list most notable breaking changes since
v31 release. Until it's done go to go to the [GitHub Releases]
(../../../releases) page and check release notes for all the releases
v31 release. Until it's done go to go to the [GitHub Releases](../../../releases)
page and check release notes for all the releases
that appeared between your old version and the new version. Look for
lists named "Changes in API that break backward compatibility" or
similar.
Expand All @@ -61,9 +59,8 @@ on Mac.
By default CEF expects that CEF framework is located at
`Contents/Frameworks/Chromium Embedded Framework.framework`
in the top-level app bundle. If that is not the case then you have
to set ApplicationSettings.[framework_dir_path]
(../api/ApplicationSettings.md#framework_dir_path) before calling
cef.Initialize().
to set ApplicationSettings.[framework_dir_path](../api/ApplicationSettings.md#framework_dir_path)
before calling cef.Initialize().

You may also need to change the structure and embedded paths in
CEF framework and in the cefpython module. Here are the default
Expand Down Expand Up @@ -113,8 +110,7 @@ as of now.
To see if some feature is working or a bug is fixed in newer CEF
release perform the following steps:

1. Go to [Spotify Automated Builds]
(http://opensource.spotify.com/cefbuilds/index.html)
1. Go to [Spotify Automated Builds](http://opensource.spotify.com/cefbuilds/index.html)
to download latest CEF for your platform. Choose "Sample
Application" binaries.
2. Extract the archive and run sample application from the
Expand Down Expand Up @@ -188,8 +184,7 @@ Now you should see debug information displayed in console like this:

Install gdb:
- On Linux type: `sudo apt-get install gdb`
- On Mac type: `brew install gdb` and then [sign gdb]
(https://sourceware.org/gdb/wiki/BuildingOnDarwin#Giving_gdb_permission_to_control_other_processes)
- On Mac type: `brew install gdb` and then [sign gdb](https://sourceware.org/gdb/wiki/BuildingOnDarwin#Giving_gdb_permission_to_control_other_processes)
- Additionally on Mac to get a meaningful stack trace with gdb do these steps:
- Install [macports](https://www.macports.org/install.php)
and restart terminal
Expand Down Expand Up @@ -224,8 +219,7 @@ supported XP was v49.

On XP you should disable GPU acceleration by using the --disable-gpu
and --disable-gpu-compositing switches. These switches must be passed
programmatically to cef.Initialize(), see [api/Command Line Switches]
(../api/CommandLineSwitches.md).
programmatically to cef.Initialize(), see [api/Command Line Switches](../api/CommandLineSwitches.md).


## Mac 32-bit support
Expand Down Expand Up @@ -266,7 +260,6 @@ A quote by Marshall Greenblatt:
> decision that may have security consequences should be evaluated
> by people who are knowledgeable about security considerations.
Reference: [Question on browser security]
(http://magpcss.org/ceforum/viewtopic.php?f=10&t=10222)
Reference: [Question on browser security](http://magpcss.org/ceforum/viewtopic.php?f=10&t=10222)
on the CEF Forum.

0 comments on commit 41fa14f

Please sign in to comment.