Add user guide
[ric-plt/xapp-frame-cpp.git] / doc / src / user / user_guide.xfm
1 .if false
2 ==================================================================================
3     Copyright (c) 2020 Nokia
4     Copyright (c) 2020 AT&T Intellectual Property.
5
6    Licensed under the Apache License, Version 2.0 (the "License");
7    you may not use this file except in compliance with the License.
8    You may obtain a copy of the License at
9
10        http://www.apache.org/licenses/LICENSE-2.0
11
12    Unless required by applicable law or agreed to in writing, software
13    distributed under the License is distributed on an "AS IS" BASIS,
14    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15    See the License for the specific language governing permissions and
16    limitations under the License.
17 ==================================================================================
18 .fi
19
20 .if false
21         Mnemonic:       user_guide.xfm
22         Abstract:       Source for the user guide. Use {X}fm to generate one of several
23                                 output types:
24                                         - postscript
25                                         - roff
26                                         - markdown
27                                         - rst
28                                         - ascii text
29
30         Date:           21 April  2020
31         Author:         E. Scott Daniels
32 .fi
33
34
35 .dv col_width 6.5i
36 .dv fname_base user_guide
37 .dv doc_title RIC xAPP C++ Framework
38 .dv doc_subtitle User's Guide
39 .dv orig_date 21 April 2020
40
41 .dv textfont Helvetica
42 .dv ditemtext Helvetica-bold
43
44 .in .5i
45 .ll 6i
46 .hn off
47
48 .im ../lib/setup.im 
49
50 .im &{lib}/front_junk.im 
51
52 .im cpp_frame.im
53
54 &h1(Example Programmes)
55 The following sections contain several example programmes which are written on
56 top of the C++ framework.
57
58 .im example1.im
59 .im example2.im
60 .im example3.im