~alan-griffiths/miral/trunk-1

« back to all changes in this revision

Viewing changes to README.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
Readme
 
2
======
 
3
 
 
4
MirAL - The Mir Abstraction Layer
 
5
---------------------------------
 
6
 
 
7
MirAL aims to provide a stable “abstraction layer” written over the top of the
 
8
Mir server API that will provide a stable ABI. There are a number of other 
 
9
goals that can be addressed at the same time:
 
10
 
 
11
 - The API can be considerably narrowed as a lot of things can be customized 
 
12
   that are of no interest to shell development;
 
13
 - A more declarative design style can be follow than the implementation 
 
14
   focussed approach that the Mir server API follows; and,
 
15
 - Common facilities that don’t belong in the Mir libraries can be provided.
 
16
 
 
17
The Mir Abstraction Layer (miral) is a both a proof-of-concept and a 
 
18
work-in-progress but may be of interest as modern C++ codebase to experiment
 
19
with.
 
20
 
 
21
There are two significant components to the MirAL project:
 
22
 
 
23
 - libmiral.so is the abstraction library itself
 
24
 - miral-shell is an example shell demonstrating the use of libmiral
 
25
 
 
26
See also:
 
27
 
 
28
 - \ref building_and_using_miral "Building and using Miral"
 
29
 - \ref tasks_for_the_interested_reader "Tasks for the interested reader"
 
30
 
 
31
License
 
32
-------
 
33
This program is free software: you can redistribute it and/or modify
 
34
it under the terms of the GNU General Public License version 3 as
 
35
published by the Free Software Foundation.
 
36
 
 
37
This program is distributed in the hope that it will be useful,
 
38
but WITHOUT ANY WARRANTY; without even the implied warranty of
 
39
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
40
GNU General Public License for more details.
 
41
 
 
42
You should have received a copy of the GNU General Public License
 
43
along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
44
 
 
45
\copyright Copyright © 2016 Canonical Ltd.
 
46
\author Alan Griffiths <alan@octopull.co.uk>