← Back to branch summary

~ubuntu-branches/ubuntu/natty/miro/natty

« back to all changes in this revision

Viewing changes to platform/gtk-x11/README

  • Committer: Bazaar Package Importer
  • Author(s): Bryce Harrington
  • Date: 2011-01-22 02:46:33 UTC
  • mfrom: (1.4.10 upstream) (1.7.5 experimental)
  • Revision ID: james.westby@ubuntu.com-20110122024633-kjme8u93y2il5nmf
Tags: 3.5.1-1ubuntu1
* Merge from debian.  Remaining ubuntu changes:
  - Use python 2.7 instead of python 2.6
  - Relax dependency on python-dbus to >= 0.83.0

Show diffs side-by-side

added added

removed removed

Lines of Context:
platform/gtk-x11/README
1
 
======
2
 
README
3
 
======
4
 
 
5
 
:Author: Will Kahn-Greene <will.guaraldi at pculture dot org>
6
 
:Date: January 14, 2010
7
 
 
8
 
 
9
 
Summary
10
 
=======
11
 
 
12
 
This is the GTK/X11 port of Miro.
13
 
 
14
 
Instructions and build requirements are documented at
15
 
https://develop.participatoryculture.org/trac/democracy/wiki/GTKX11BuildDocs
16
 
 
17
 
If you have problems, visit us on ``#miro-hackers`` on
18
 
``irc.freenode.net``.
19
 
 
20
 
 
21
 
Build and run
22
 
=============
23
 
 
24
 
To compile and run Miro in the current directory, do::
25
 
 
26
 
   ./run.sh
27
 
 
28
 
If you have the required dependencies it should build Miro and run it.
29
 
 
30
 
See https://develop.participatoryculture.org/projects/dtv/wiki/GTKX11BuildDocs
31
 
for more information on building and executing the GTK-X11 platform code.
32
 
The information at this URL is considered the authoritative source.
33
 
 
34
 
To run Miro in "debug mode" (i.e. in gdb)::
35
 
 
36
 
   ./run.sh --debug
37
 
 
38
 
Obviously, this requires gdb.
39
 
 
40
 
For more command-line options including how to set preferences on the command 
41
 
and what preferences are available, do::
42
 
 
43
 
   ./run.sh --help
44
 
 
45
 
Set the ``HOME`` environment variable to switch where Miro saves database
46
 
and other files::
47
 
 
48
 
   mkdir /tmp/foo
49
 
   HOME=/tmp/foo ./run.sh
50
 
 
51
 
.. Note:: Setting ``HOME`` doesn't work in KDE--it causes other problems.
52
 
 
53
 
 
54
 
Preferences
55
 
===========
56
 
 
57
 
Miro stores preferences in gconf.  To wipe out all preferences, do::
58
 
 
59
 
   gconftool-2 --recursive-unset /apps/miro
60
 
 
61
 
To backup your preferences, do::
62
 
 
63
 
   gconftool-2 --dump /apps/miro > /tmp/foobar
64
 
 
65
 
 
66
 
Unittest instructions
67
 
=====================
68
 
 
69
 
Once you get ``./run.sh`` working, you can run the unittests on GTK-X11 
70
 
platform.  Do the following::
71
 
 
72
 
   ./run.sh --unittest
73
 
 
74
 
 
75
 
This will go through all the unittests on the GTK-X11 platform and spit out 
76
 
any errors to stdout and stderr.
77
 
 
78
 
 
79
 
Problems with gstreamer
80
 
=======================
81
 
 
82
 
Make sure you have gstreamer plugins installed.  That solves most
83
 
problems.