aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--INSTALL138
-rw-r--r--README28
l---------README.md1
3 files changed, 36 insertions, 131 deletions
diff --git a/INSTALL b/INSTALL
index d8d7e0f..f45abee 100644
--- a/INSTALL
+++ b/INSTALL
@@ -368,11 +368,10 @@ operates.
Installing on Ubuntu
====================
- Installing the experiment-player on Ubuntu is straight forward. If you
+ Installing the GtkVlcPlayer widget on Ubuntu is straight forward. If you
would like to build from a tar-ball, first install all necessary packages:
- sudo apt-get install build-essential xsltproc \
- libgtk2.0-dev libvlc-dev libxml2-dev libx11-dev
+ sudo apt-get install build-essential libgtk2.0-dev libvlc-dev
If you build from a Git repository (without prebuilt ./configure) you will
also need autoconf, automake, etc:
@@ -383,31 +382,20 @@ also need autoconf, automake, etc:
autoreconf -i
- Then you can install the package as usual. An `experiment-player` binary
-will be installed into /usr/local/bin:
+ Then you can install the package as usual:
./configure
make
sudo make install
- If you plan to develop the experiment-player it is recommended to install
-additional packages which will be found by ./configure automatically:
+ The GtkVlcPlayer can then be configured to generate Doxygen
+documentation:
- sudo apt-get install doxygen libgladeui-1-dev glade \
- docbook-xsl docbook5-xml
-
- The experiment-player can then be configured to generate Doxygen
-documentation, install Glade catalog files into the appropriate directory and
-build using debug information. Also generating the user documentation using
-Docbook will be much faster now:
-
- ./configure --enable-doxygen-doc --enable-doxygen-extract-private \
- CFLAGS="-g -O0"
+ ./configure --enable-doxygen-doc
make
sudo make install
- There are even some gtester test suites that will be invoked automatically
-with the standard "check" target. To run the test suites, use
+ To build example programs:
make check
@@ -418,8 +406,6 @@ Installing on Windows
Minimalist GNU for Windows (MinGW).
Unfortunately, installation is not as trivial as on modern Unices since you
have to install many dependencies on your own.
- * Since there is no gtester for Windows, test suites cannot be run
- automatically.
* The program may or may not work with different versions of tools and
libraries. Sometimes there will be notes about different versions in this
guide. However for the sake of simplicity, the command line examples assume
@@ -451,23 +437,7 @@ http://www.gtk.org/download/win32.php:
wget http://ftp.gnome.org/pub/gnome/binaries/win32/gtk+/2.24/gtk+-bundle_2.24.10-20120208_win32.zip
unzip gtk+-bundle_2.24.10-20120208_win32.zip -d /mingw/
- 4) Download and intall libxml2. Windows binaries are provided here:
-http://www.zlatkovic.com/libxml.en.html:
-
- wget ftp://ftp.zlatkovic.com/pub/libxml/libxml2-2.7.8.win32.zip
- unzip libxml2-2.7.8.win32.zip
- cp libxml2-2.7.8.win32/bin/* /mingw/bin/
- cp libxml2-2.7.8.win32/bin/libxml2.dll /mingw/lib/
- cp -r libxml2-2.7.8.win32/include/libxml/ /mingw/include/
-
- 5) Download and install libxslt2. Actually we only need the xsltproc tool
-at build time.
-
- wget ftp://ftp.zlatkovic.com/pub/libxml/libxslt-1.1.26.win32.zip
- unzip libxslt-1.1.26.win32.zip
- cp libxslt-1.1.26.win32/bin/* /mingw/bin/
-
- 6) Download and install libVLC (http://www.videolan.org/vlc/index.html).
+ 4) Download and install libVLC (http://www.videolan.org/vlc/index.html).
Every VLC version beginning with v1.1.10 should work - it has been tested
with v1.1.10, v1.1.11 and v2.0.0. The libVLC SDK is packaged with the ZIP
file download.
@@ -480,102 +450,14 @@ file download.
mkdir /mingw/lib/vlc
cp -r vlc-2.0.0/plugins/ /mingw/lib/vlc/
- In order to execute the experiment-player from the MSYS Shell, libVLC has to
-find the plugins you just installed. The easiest way to achieve that is to
-set the "VLC_PLUGIN_PATH" environment variable. Using your favourite editor,
-add the following line to /etc/profile:
-
- export VLC_PLUGIN_PATH=/mingw/lib/vlc/plugins
-
- Please note that the editor must support Unix line-breaks. You may use VIM
-which should already be installed.
-
- 7) It is recommended but optional to install the Docbook XSL stylesheets
-(http://docbook.sourceforge.net/) which speeds up the generation of the user
-documentation.
-
- wget http://downloads.sourceforge.net/project/docbook/docbook-xsl/1.76.1/docbook-xsl-1.76.1.zip
- unzip docbook-xsl-1.76.1.zip
- cd docbook-xsl-1.76.1
- ./install.sh
-
- The XML_CATALOG_FILES environment variable must be updated so the XSLT
-processor (xsltproc) can find the locally installed stylesheets. To do so,
-use your favourite editor to add the following line to ~/.profile:
-
- . ~/docbook-xsl-1.76.1/.profile.incl
-
- 8) For doing actual development you will probably want to generate
+ 5) For doing actual development you will probably want to generate
code documentation using Doxygen (www.doxygen.org).
You can download a GUI installer from
ftp://ftp.stack.nl/pub/users/dimitri/doxygen-1.8.1.2-setup.exe
The installer will extend the PATH variable so there is nothing else for
you to do - Doxygen will be found by ./configure!
- 9) For designing the user interface you will need Glade 3
-(http://glade.gnome.org/). There is a Windows GUI installer available from
-http://ftp.gnome.org/pub/GNOME/binaries/win32/glade3/3.6/glade3-3.6.7-with-GTK+.exe
-The installer modifies PATH but generally *should* not interfere with the MinGW
-GTK+ installation.
-Glade should always be executed from the MSYS shell since the program's UI
-definition uses custom widgets whose DLLs, Glade catalog files and dependencies
-are installed into the MinGW hierarchy. In order for Glade to find the widget
-DLLs and catalogs you should add these lines to /etc/profile:
-
- export GLADE_CATALOG_PATH="\mingw\share\gtk-vlc-player\catalogs:\mingw\share\experiment-player\catalogs"
- export GLADE_MODULE_PATH="\mingw\bin"
-
-Additional notes:
- * Even though, the UI was designed using Glade 3.6.7, there seem to be
- incompatibilities between the Linux and Windows versions of Glade. When
- opening the UI definition, it may look screwed and has to be fixed by hand
- (e.g. you will have to set explicitly that a VBox is vertical...).
- * You may have to execute Glade giving an absolute path, e.g.:
- /c/Program\ Files/Gtk+/glade-3.exe
-
- 10) The experiment-player is versioned using Git (http://git-scm.com/).
-If you need Git you could install it using a graphical installer that can
-be downloaded here:
-http://code.google.com/p/msysgit/downloads/list?q=full+installer+official+git
-This provides a graphical Git client that may be used right away. There is
-also a "Git Bash" based on MSYS that can be used. Unfortunately
-"Git for Windows" comes with its own MSYS shell. To use the command line
-client with the MinGW/MSYS installation that you have just prepared, you may
-add the following line to /etc/profile (may differ for your Git installation):
-
- export PATH=$PATH:/c/Program\ Files/Git/bin
-
- 11) You may now build the experiment-player binaries. Restart your MSYS shell
-if you have not already!
-It may be built like any other Autoconf-based project but there are some
-Windows-specified flags (like --enable-console). Also there are some things
-to keep in mind when building deployment binaries. Therefore two helper scripts
-are provided. For doing a typical development installation you should execute
-something like this from the source code directory:
-
- ./makemake_mingw_dev.sh
- make install
-
- This will build and install the experiment-player binaries into the MinGW
-hierarchy.
- * "experiment-player" can be executed everywhere (just like on Linux/Unix).
- * It includes a console (which does not make sense for a normal Windows GUI
- application).
- * It will be built with no optimizations and with debugging symbols.
- * A complete developer documentation will be generated for you (doc/doxygen/).
-
- To build deployment binaries you can execute the ./build_mingw_binaries.sh
-script. It will completely clean the build directories, build the deployment
-binaries and create a ZIP file (experiment-player-win32.zip).
-This ZIP file can then be simply unpacked by the user - no installer
-is required.
-The ZIP file also contains all dependency DLLs, except GTK+. GTK+ must be
-installed by the user! You are recommended to point the user to the
-"GTK+ for Windows Runtime Environment Installer" (http://gtk-win.sourceforge.net/).
- * Only the runtime installer is required.
- * The user may also download the themes installer, enabling the user to
- change the look-and-feel of programs using the runtime (i.e. the experiment
- player). The default "MS Windows" look however should be sufficient...
+ 6) Build as usual
Notes on Windows 2000
=====================
diff --git a/README b/README
index ba28d3d..3038009 100644
--- a/README
+++ b/README
@@ -1,4 +1,26 @@
-For installation (build) instructions refer to ./INSTALL
+Overview
+========
-For user documentation and installation instructions
-refer to ./doc/experiment-player.html
+GtkVlcPlayer is an extremely easy to use GTK+ 2.0 widget that
+wraps [libVLC](http://www.videolan.org/vlc/libvlc.html).
+In other words it allows you to easily embed the
+[VLC player](http://www.videolan.org/vlc/) into a GTK+ project.
+
+There is a sample program in `examples/simple.c`.
+It is built with `make check`.
+
+GtkVlcPlayer was originally developed as part of a larger
+project for the Otto-von-Guericke University Magdeburg.
+
+Features
+========
+
+* Simple API (perhaps too simple)
+* Automatically supports fullscreen playback by double-clicking
+ the GtkVlcPlayer widget
+* Supports synchronization with sliders and volume widgets via
+ GtkAdjustments
+* Comes with a [Glade 3](https://glade.gnome.org/) catalog file
+ so you can easily use it in Glade UIs.
+* Runs on Windows (compile with MinGW)
+* Supports a wide range libVLC versions beginning with v1.1.10
diff --git a/README.md b/README.md
new file mode 120000
index 0000000..100b938
--- /dev/null
+++ b/README.md
@@ -0,0 +1 @@
+README \ No newline at end of file