1
=== modified file 'doc/Doxyfile.in'
2
--- doc/Doxyfile.in	2017-09-07 09:53:20 +0000
3
+++ doc/Doxyfile.in	2017-09-28 13:33:53 +0000
4
@@ -784,7 +784,8 @@
5
784
INPUT                  = @CMAKE_CURRENT_SOURCE_DIR@/README.md \
784
INPUT                  = @CMAKE_CURRENT_SOURCE_DIR@/README.md \
6
785
                         @CMAKE_CURRENT_SOURCE_DIR@/HACKING.md \
785
                         @CMAKE_CURRENT_SOURCE_DIR@/HACKING.md \
7
786
                         @CMAKE_CURRENT_SOURCE_DIR@/doc \
786
                         @CMAKE_CURRENT_SOURCE_DIR@/doc \
9
787
                         @CMAKE_CURRENT_SOURCE_DIR@/examples \
787
                         @CMAKE_CURRENT_SOURCE_DIR@/examples/miral-kiosk \
10
788
                         @CMAKE_CURRENT_SOURCE_DIR@/examples/miral-shell \
11
788
                         @CMAKE_CURRENT_SOURCE_DIR@/include \
789
                         @CMAKE_CURRENT_SOURCE_DIR@/include \
12
789
                         @MIR_GENERATED_INCLUDE_DIRECTORIES_FLATTENED@
790
                         @MIR_GENERATED_INCLUDE_DIRECTORIES_FLATTENED@
13
790
791
14
@@ -859,7 +860,9 @@
15
859
# Note that relative paths are relative to the directory from which doxygen is
860
# Note that relative paths are relative to the directory from which doxygen is
16
860
# run.
861
# run.
17
861
862
19
862
EXCLUDE                =
863
EXCLUDE                = @CMAKE_CURRENT_SOURCE_DIR@/include/server \
20
864
                         @CMAKE_CURRENT_SOURCE_DIR@/include/platform \
21
865
                         @CMAKE_CURRENT_SOURCE_DIR@/include/platforms
22
863
866
23
864
# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
867
# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
24
865
# directories that are symbolic links (a Unix file system feature) are excluded
868
# directories that are symbolic links (a Unix file system feature) are excluded
25
@@ -876,9 +879,10 @@
26
876
# exclude all test directories for example use the pattern */test/*
879
# exclude all test directories for example use the pattern */test/*
27
877
880
28
878
EXCLUDE_PATTERNS       = *.capnp.c++ \
881
EXCLUDE_PATTERNS       = *.capnp.c++ \
32
879
                         @CMAKE_CURRENT_SOURCE_DIR@/include/server/* \
882
                         */detail/* \
33
880
                         @CMAKE_CURRENT_SOURCE_DIR@/include/test/mir/* \
883
                         @CMAKE_CURRENT_SOURCE_DIR@/examples/multi_stream.cpp \
34
881
                         @CMAKE_CURRENT_SOURCE_DIR@/examples/multi_stream.cpp
884
                         @CMAKE_CURRENT_SOURCE_DIR@/examples/uses_non_client_symbol.cpp \
35
885
                         @CMAKE_CURRENT_SOURCE_DIR@/examples/miral-shell/titlebar_config.*
36
882
886
37
883
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
887
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
38
884
# (namespaces, classes, functions, etc.) that should be excluded from the
888
# (namespaces, classes, functions, etc.) that should be excluded from the
39
885
889
40
=== modified file 'doc/mainpage.md'
41
--- doc/mainpage.md	2017-09-08 13:26:03 +0000
42
+++ doc/mainpage.md	2017-09-28 13:33:53 +0000
43
@@ -5,14 +5,32 @@
44
5
window server system to unlock next-generation user experiences for devices
5
window server system to unlock next-generation user experiences for devices
45
6
ranging from Linux desktop to mobile and IoT devices powered by Ubuntu.
6
ranging from Linux desktop to mobile and IoT devices powered by Ubuntu.
46
7
7
48
8
 - If you just want to try out the Mir demos, see: \ref getting_and_using_mir
8
 - If you want to use the Mir snaps, see: 
49
9
   [Run a kiosk snap on Ubuntu Core](https://developer.ubuntu.com/core/examples/snaps-on-mir)
50
10
51
11
 - If you want to try out the Mir demos on desktop, see: \ref getting_and_using_mir
52
9
12
53
10
 - If you want to get involved in Mir development, see: \ref getting_involved_in_mir
13
 - If you want to get involved in Mir development, see: \ref getting_involved_in_mir
54
11
14
55
12
Using Mir for client development
15
Using Mir for client development
56
13
--------------------------------
16
--------------------------------
57
14
17
59
15
Install the headers and libraries for using libmirclient in development:
18
This is usually something you don't need to do explicitly, it is normally 
60
19
handled by a GUI toolkit (or library).
61
20
62
21
A toolkit can run on Mir in three ways: using Wayland protocols, using the Mir 
63
22
client API or using X11 translation by the Xmir server.
64
23
65
24
 - Qt, has "wayland" and "mir" plugins that can be selected by setting
66
25
   the QT_QPA_PLATFORM environment variable to "wayland" or "ubuntumirclient" 
67
26
   respectively.
68
27
69
28
 - SDL can be built with "wayland" and "mir" support and these options selected
70
29
   by setting the SDL_VIDEODRIVER environment variable to "wayland" or "mir".
71
30
   
72
31
If want to use the Mir client library directly (e.g. you are working on "mir" 
73
32
support for a toolkit or library) Install the headers and libraries for using
74
33
libmirclient in development:
75
16
34
76
17
    $ sudo apt install libmirclient-dev
35
    $ sudo apt install libmirclient-dev
77
18
36
Status:	Merged
Merged at revision:	4276
Proposed branch:	lp:~alan-griffiths/mir/update-docs
Merge into:	lp:mir
Diff against target:	76 lines (+29/-7) 2 files modified doc/Doxyfile.in (+9/-5) doc/mainpage.md (+20/-2)
To merge this branch:	bzr merge lp:~alan-griffiths/mir/update-docs
Related bugs:	Link a bug report
Reviewer	Review Type	Date Requested	Status
Mir CI Bot	continuous-integration		Needs Fixing on 2017-09-29
Brandon Schaefer (community)		2017-09-27	Approve on 2017-09-29
Review via email: mp+331448@code.launchpad.net