-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathREADME
84 lines (59 loc) · 3.91 KB
/
README
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
Boost QCH Help Generator README
Copyright (C) 2013-2014 Gabriel T. Sharp
This file is part of boost qch help generator.
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
This README is pretty small, since the project is pretty small. The files
included with the help generator are from the Boost help v1.54 (complete)
and are subject to their own licenses (see LICENSE_1_0.txt in this direct
ory).
The files that belong to the help generator are listed below.
File Purpose
boost.qch (Generated) The final output, help file used for Qt-Creator
boost.qhp (Generated) Used by make and qhelpgenerator to build the helpfile
boost.qhpsrc Boilerplate chunks used to create the qhp file above (dont edit this!)
BUGS List of known limitations, bugs, or shortcomings in this project
COMPILING Instructions on how to create the boost.qch, the purpose of the project
files.list (Generated) Used by make via make-boost-qhp.sh
files-unformatted.list (Generated) Used by make via generatesections.sh (this and the previous
files.list are generated by generatelists.sh)
generatelists.sh Used by make to generate the files.list and files-unformatted.list. Uses
the files to make the qhp project file and for the generatesections.sh
generatesections.sh Used by make to generate the sections used to make the qhp project file
HISTORY History of previous versions, commits, or releases
LICENSE The license, it applies only to the project files listed here
make-boost-qhp.sh Used by make to create the qhp project file
Makefile Used by make to run all other scripts that ultimately create the final
output file (boost.qch).
README A short description of the project & files, plus any other notables
rewrite-link (Not Used) Used by rewritelinks, operates on a single file
rewritelinks (Not Used) Provided as a template to rewrite links if you need to do this
you should know why and edit the rewrite-link to work the way you want it
to. The default is to strip out ../../ references. This is only useful when
making a qch file that includes only part of the documentation (providing
that you moved the structure down).
sections.list (Generated) Used by make-boost-qhp to build the qhp project file (generated
by generatesections.sh)
Usage
The qch comes pre-compiled and ready to use. If you need to rebuild the files, please read COMPILING.
Installation
Throw that qch file in any old directory you want. Then use Qt Creator or Qt Assistant and add it to your
list of help collections. That's about it.
Contact
the latest version of the project can be found here:
http://gitorious.org/boostqhp/154
the author:
website: http://paradisim.twilightparadox.com http://gitorious.org/+paradisim
email: Gabriel Sharp <osirisgothra@hotmail.com>
Notes
Future versions of the boost documentation can be generated just as easily, just copy the contents of the
'doc' folder into the root along with all it's subdirectories. See COMPILING for how to rebuild.