~alan-griffiths/miral/trunk-1

« back to all changes in this revision

Viewing changes to building_and_using_miral.md

  • Committer: Alan Griffiths
  • Date: 2016-04-11 10:27:12 UTC
  • Revision ID: alan@octopull.co.uk-20160411102712-tofjao10rywgkmqg
A bit of documentation

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
Building and using Miral
 
2
========================
 
3
 
 
4
These instructions assume that you’re using Ubuntu 16.04LTS or later, I’ve not
 
5
earlier Ubuntu versions or other distributions.
 
6
 
 
7
You’ll need a few development and utility packages installed, along with the
 
8
Mir development packages (if you’re working on a phone or tablet use 
 
9
mir-graphics-drivers-android in place of mir-graphics-drivers-desktop):
 
10
 
 
11
    $ sudo apt-get install cmake g++ make bzr python-pil
 
12
    $ sudo apt-get install mir-graphics-drivers-desktop libmirserver-dev libmirclient-dev
 
13
    
 
14
With these installed you can checkout and build miral:
 
15
 
 
16
    $ bzr branch lp:miral
 
17
    $ mkdir miral/build
 
18
    $ cd  miral/build
 
19
    $ cmake ..
 
20
    $ make
 
21
    
 
22
This creates libmiral.so in the lib directory and an example shell 
 
23
(miral-shell) in the bin directory. This can be run directly:
 
24
 
 
25
    $ bin/miral-shell
 
26
    
 
27
With the default options this runs in a window on X (which is convenient for
 
28
development). To run independently of X you need to grant access to the 
 
29
graphics hardware and specify a VT to run in. For example:
 
30
 
 
31
    $ sudo bin/miral-shell --vt 4 --arw-file --file $XDG_RUNTIME_DIR/mir_socket
 
32
    
 
33
The miral-shell example is simple, don’t expect to see a sophisticated launcher
 
34
by default. You can start mir apps from the command-line. For example:
 
35
 
 
36
    $ GDK_BACKEND=mir gnome-terminal --app-id com.canonical.miral.Terminal
 
37
    
 
38
That’s right, the GDK toolkit runs on Mir and a lot of standard GTK applications
 
39
will “just work”. (Those that assume the existence of an X11 server will have
 
40
problems though.)
 
41
 
 
42
To exit from miral-shell type Ctrl-Alt-BkSp.
 
 
b'\\ No newline at end of file'