~ubuntu-branches/ubuntu/vivid/frescobaldi/vivid

« back to all changes in this revision

Viewing changes to INSTALL

  • Committer: Package Import Robot
  • Author(s): Ryan Kavanagh
  • Date: 2012-01-03 16:20:11 UTC
  • mfrom: (1.4.1)
  • Revision ID: package-import@ubuntu.com-20120103162011-tsjkwl4sntwmprea
Tags: 2.0.0-1
* New upstream release 
* Drop the following uneeded patches:
  + 01_checkmodules_no_python-kde4_build-dep.diff
  + 02_no_pyc.diff
  + 04_no_binary_lilypond_upgrades.diff
* Needs new dependency python-poppler-qt4
* Update debian/watch for new download path
* Update copyright file with new holders and years

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
How to install Frescobaldi:
2
 
===========================
3
 
 
4
 
To install Frescobaldi in /usr/local:
5
 
 
6
 
  cmake .
7
 
  make
8
 
  make install
9
 
 
10
 
To install Frescobaldi in your distributions default KDE4 directory (also 
11
 
recommended for creating installable distribution packages):
12
 
 
13
 
  cmake . -DCMAKE_INSTALL_PREFIX=$(kde4-config --exec-prefix)
14
 
  make
15
 
  make install
16
 
 
17
 
 
18
 
Try Frescobaldi without installing:
19
 
===================================
20
 
 
21
 
Just run the 'run' script:
22
 
 
23
 
  ./run
24
 
 
25
 
If your system is missing some necessary software, the script will inform you.
26
 
If everything is fine, Frescobaldi will be added to your Applications menu
27
 
and started right away without installing anything. An executable 'frescobaldi'
28
 
will be created in the current directory as well.
29
 
 
30
 
Running the 'run' script again will give you the option to remove Frescobaldi
31
 
from your Applications menu.
32
 
 
33
 
 
34
 
Installing Frescobaldi from SVN:
35
 
================================
36
 
 
37
 
If you install Frescobaldi from a SubVersion checkout, you need a very recent
38
 
LilyPond, ImageMagick and GNU Gettext to built the LilyPond-generated icons and
39
 
the translations.
40
 
 
41
 
If you install Frescobaldi from a released tarball (e.g.
42
 
frescobaldi-1.1.3.tar.gz), the icons and translations are already prebuilt.
43
 
The makedist.sh shell script creates a tar ball from a SVN checkout.
44
 
 
45
 
 
46
 
CMake command line options:
47
 
===========================
48
 
 
49
 
The installation can be customized in a few ways.
50
 
 
51
 
If you don't want to install the User Guide (some Linux distros split
52
 
applications and their documentation), add -DHANDBOOK=NO to the cmake command
53
 
line.
54
 
 
55
 
If you don't want to bytecompile the Python modules on install (some Linux
56
 
distros want their own installers to do that), add -DBYTECOMPILE=NO to the cmake
57
 
command line.
58
 
 
59
 
If you get errors about missing Python modules, but you're sure that they are
60
 
installed, CMake might be finding the wrong Python version. If you e.g. install
61
 
PyKDE4 inside Python 2.6 but CMake is finding Python 2.5 then you get errors
62
 
about missing modules. You can fix this by explicitly defining the Python
63
 
interpreter to use. Add -DPYTHON_EXECUTABLE=/usr/bin/python2.6 to the cmake
64
 
command line in that case.
65
 
 
66
 
If you install Frescobaldi from a SVN checkout (or have removed the prebuilt/
67
 
directory) the icons in pics/ will need to be rebuilt using LilyPond and convert
68
 
(from ImageMagick). You can define the locations of those programs using the
69
 
LILYPOND_EXECUTABLE and the CONVERT_EXECUTABLE CMake variables. Otherwise the
70
 
programs are searched for in the PATH environment variable. You need at least
71
 
LilyPond-2.13.19 to build the icons.
72
 
 
73
 
If you install Frescobaldi from a SVN checkout (or have removed the prebuilt/
74
 
directory) the translations in po/ will need to be rebuilt using Gettext's
75
 
msgfmt tool. If this tool is not in your $PATH, you can define the
76
 
GETTEXT_MSGFMT_EXECUTABLE CMake variable.
 
1
INSTALL for Frescobaldi 2.0.
 
2
============================
 
3
 
 
4
You can run Frescobaldi without installing. Just unpack and then run:
 
5
 
 
6
  python frescobaldi
 
7
 
 
8
 
 
9
The Frescobaldi package is based on distutils. No build process is needed as
 
10
Frescobaldi is fully written in the interpreted Python language. To install in
 
11
the default location:
 
12
 
 
13
  sudo python setup.py install
 
14
 
 
15
 
 
16
To run Frescobaldi, then simply type
 
17
 
 
18
  frescobaldi
 
19
 
 
20
 
 
21
If you want to install into /usr instead of /usr/local:
 
22
 
 
23
  python setup.py install --prefix=/usr
 
24
 
 
25
 
 
26
If you have a Debian-based system such as Ubuntu, and you get the error
 
27
message "ImportError: No module named frescobaldi_app.main", try:
 
28
 
 
29
  python setup.py install --install-layout=deb
 
30
 
 
31
 
 
32
See the distutils documentation for more install options.
77
33
 
78
34
 
79
35
Dependencies:
80
36
=============
81
37
 
82
 
This is the 1.2 stable branch of Frescobaldi. It depends on:
83
 
- Python 2.6 or 2.7
84
 
- python-dbus (http://www.freedesktop.org/wiki/Software/DBusBindings#python)
85
 
- Qt      >= 4.6
86
 
- SIP     >= 4.9.3
87
 
- PyQt4   >= 4.6
88
 
- kdelibs >= 4.3.2
89
 
- PyKDE4  >= 4.0.2 Rev 2
90
 
 
91
 
Frescobaldi embeds the KParts of the following applications:
92
 
- Okular  (required, necessary for the PDF preview)
93
 
- Konsole (optional, used for the Terminal tool)
94
 
- KMid    (recommended, needs version 2.4.0 or higher, for the MIDI player)
95
 
 
96
 
You also might need to install some of the the corresponding -dev packages from
97
 
the above to install Frescobaldi from this source package.
98
 
 
99
 
 
100
 
Other useful programs to use with Frescobaldi:
101
 
==============================================
102
 
 
103
 
Some other useful programs to use together with Frescobaldi are:
104
 
- LilyPond (of course!) http://lilypond.org/
105
 
- Rumor                 http://www.volny.cz/smilauer/rumor/
106
 
- a MIDI player like KMid or timidity++, etc.
 
38
Frescobaldi 2.0 is written in Python version 2.6 or 2.7 (3.x support is planned)
 
39
and depends on Qt4.7 and PyQt4.8, and uses the python-poppler-qt4 binding to
 
40
Poppler for the built-in PDF preview.
 
41
 
 
42
For MIDI the PortMidi library is used, either via importing 'pypm',
 
43
'pyportmidi._pyportmidi, or, if that is not available, loading the pygame.pypm
 
44
module from pygame; or, as a last resort, embedding the PortMidi C-library via
 
45
ctypes. MIDI is optional.
 
46
 
 
47
Required:
 
48
    Python:
 
49
        http://www.python.org/
 
50
    Qt4:
 
51
        http://qt.nokia.com/
 
52
    PyQt4:
 
53
        http://www.riverbankcomputing.co.uk/software/pyqt/
 
54
    Poppler:
 
55
        http://poppler.freedesktop.org/
 
56
    python-poppler-qt4:
 
57
        http://python-poppler-qt4.googlecode.com/
 
58
 
 
59
Optional:
 
60
    PortMidi:
 
61
        http://portmedia.sourceforge.net/portmidi/
 
62
 
 
63
Of course you'll need to install one or more versions of LilyPond!
107
64