-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathhowto.html
198 lines (182 loc) · 11.9 KB
/
howto.html
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
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>How-to Guides — BASIS</title>
<link rel="stylesheet" href="_static/cmake-basis.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: 'v3.3 (fb18c98)',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="shortcut icon" href="_static/favicon.ico"/>
<link rel="author" title="About these documents" href="about.html" />
<link rel="top" title="BASIS" href="index.html" />
<link rel="next" title="Create/Modify a Project" href="howto/create-and-modify-project.html" />
<link rel="prev" title="Quick Start" href="quickstart.html" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9">
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="howto/create-and-modify-project.html" title="Create/Modify a Project"
accesskey="N">next</a></li>
<li class="right" >
<a href="quickstart.html" title="Quick Start"
accesskey="P">previous</a> |</li>
<li><a href="sidebar.html">BASIS</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="how-to-guides">
<span id="howtoguides"></span><h1>How-to Guides<a class="headerlink" href="#how-to-guides" title="Permalink to this headline">¶</a></h1>
<p>The how-to guides describe BASIS concepts and best practices which help to conform
with the <a class="reference internal" href="standard.html"><span class="doc">Standards</span></a> defined by BASIS, and explain common tasks such as creating
a new project or its installation.</p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="howto/create-and-modify-project.html">Create/Modify a Project</a><ul>
<li class="toctree-l2"><a class="reference internal" href="howto/create-and-modify-project.html#create-a-new-project">Create a New Project</a></li>
<li class="toctree-l2"><a class="reference internal" href="howto/create-and-modify-project.html#modify-an-existing-project">Modify an Existing Project</a></li>
<li class="toctree-l2"><a class="reference internal" href="howto/create-and-modify-project.html#modularize-a-project">Modularize a Project</a></li>
<li class="toctree-l2"><a class="reference internal" href="howto/create-and-modify-project.html#upgrade-a-project">Upgrade a Project</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="howto/use-and-customize-templates.html">Using and Customizing Templates</a><ul>
<li class="toctree-l2"><a class="reference internal" href="howto/use-and-customize-templates.html#available-templates">Available Templates</a></li>
<li class="toctree-l2"><a class="reference internal" href="howto/use-and-customize-templates.html#use-a-template">Use a Template</a></li>
<li class="toctree-l2"><a class="reference internal" href="howto/use-and-customize-templates.html#create-a-custom-template">Create a Custom Template</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="howto/cmake-options.html">CMake Options</a><ul>
<li class="toctree-l2"><a class="reference internal" href="howto/cmake-options.html#standard-cmake">Standard CMake</a></li>
<li class="toctree-l2"><a class="reference internal" href="howto/cmake-options.html#basis-options">BASIS Options</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="howto/configure-project.html">Configure a Project</a><ul>
<li class="toctree-l2"><a class="reference internal" href="howto/configure-project.html#build-configuration">Build Configuration</a></li>
<li class="toctree-l2"><a class="reference internal" href="howto/configure-project.html#header-files">Header Files</a></li>
<li class="toctree-l2"><a class="reference internal" href="howto/configure-project.html#custom-layout">Custom Layout</a></li>
<li class="toctree-l2"><a class="reference internal" href="howto/configure-project.html#superbuild">Superbuild</a></li>
<li class="toctree-l2"><a class="reference internal" href="howto/configure-project.html#test-configuration">Test Configuration</a></li>
<li class="toctree-l2"><a class="reference internal" href="howto/configure-project.html#installation">Installation</a></li>
<li class="toctree-l2"><a class="reference internal" href="howto/configure-project.html#redistributable-files">Redistributable Files</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="howto/manage-data.html">Managing Test Data</a></li>
<li class="toctree-l1"><a class="reference internal" href="howto/document.html">Documenting Software</a><ul>
<li class="toctree-l2"><a class="reference internal" href="howto/document.html#documentation-quick-start">Documentation Quick Start</a></li>
<li class="toctree-l2"><a class="reference internal" href="howto/document.html#doxygen-documentation">Doxygen Documentation</a></li>
<li class="toctree-l2"><a class="reference internal" href="howto/document.html#sphinx-documentation">Sphinx Documentation</a></li>
<li class="toctree-l2"><a class="reference internal" href="howto/document.html#markdown">Markdown</a></li>
<li class="toctree-l2"><a class="reference internal" href="howto/document.html#creating-documentation">Creating Documentation</a></li>
<li class="toctree-l2"><a class="reference internal" href="howto/document.html#software-manual">Software Manual</a></li>
<li class="toctree-l2"><a class="reference internal" href="howto/document.html#developer-s-guide">Developer’s Guide</a></li>
<li class="toctree-l2"><a class="reference internal" href="howto/document.html#api-documentation">API Documentation</a></li>
<li class="toctree-l2"><a class="reference internal" href="howto/document.html#software-web-site">Software Web Site</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="howto/branch-and-release.html">Branch and Release</a><ul>
<li class="toctree-l2"><a class="reference internal" href="howto/branch-and-release.html#branching-and-merging">Branching and Merging</a></li>
<li class="toctree-l2"><a class="reference internal" href="howto/branch-and-release.html#releasing-software">Releasing Software</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="howto/package.html">Packaging Software</a><ul>
<li class="toctree-l2"><a class="reference internal" href="howto/package.html#distribution-of-sources">Distribution of Sources</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="howto/install.html">Install any Software</a><ul>
<li class="toctree-l2"><a class="reference internal" href="howto/install.html#build-steps-overview">Build Steps Overview</a></li>
<li class="toctree-l2"><a class="reference internal" href="howto/install.html#prerequisites">Prerequisites</a></li>
<li class="toctree-l2"><a class="reference internal" href="howto/install.html#build-and-installation">Build and Installation</a></li>
<li class="toctree-l2"><a class="reference internal" href="howto/install.html#deinstallation">Deinstallation</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="howto/run-automated-tests.html">Automated Testing</a><ul>
<li class="toctree-l2"><a class="reference internal" href="howto/run-automated-tests.html#the-basistest-family-of-scripts">The basistest family of scripts</a></li>
<li class="toctree-l2"><a class="reference internal" href="howto/run-automated-tests.html#cdash-integration">CDash Integration</a></li>
<li class="toctree-l2"><a class="reference internal" href="howto/run-automated-tests.html#administration-of-software-testing">Administration of Software Testing</a></li>
</ul>
</li>
</ul>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="index.html">
<img class="logo" src="_static/logo_title.svg" alt="Logo"/>
</a></p>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
<h3><a href="contents.html">Table Of Contents</a></h3>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="index.html">Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="quickstart.html">Quick Start</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">How-to Guides</a><ul>
<li class="toctree-l2"><a class="reference internal" href="howto/create-and-modify-project.html">Create/Modify a Project</a></li>
<li class="toctree-l2"><a class="reference internal" href="howto/use-and-customize-templates.html">Using and Customizing Templates</a></li>
<li class="toctree-l2"><a class="reference internal" href="howto/cmake-options.html">CMake Options</a></li>
<li class="toctree-l2"><a class="reference internal" href="howto/configure-project.html">Configure a Project</a></li>
<li class="toctree-l2"><a class="reference internal" href="howto/manage-data.html">Managing Test Data</a></li>
<li class="toctree-l2"><a class="reference internal" href="howto/document.html">Documenting Software</a></li>
<li class="toctree-l2"><a class="reference internal" href="howto/branch-and-release.html">Branch and Release</a></li>
<li class="toctree-l2"><a class="reference internal" href="howto/package.html">Packaging Software</a></li>
<li class="toctree-l2"><a class="reference internal" href="howto/install.html">Install any Software</a></li>
<li class="toctree-l2"><a class="reference internal" href="howto/run-automated-tests.html">Automated Testing</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="standard.html">Standards</a></li>
<li class="toctree-l1"><a class="reference internal" href="guideline.html">Guidelines</a></li>
<li class="toctree-l1"><a class="reference internal" href="reference.html">Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="apidoc.html">API</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="changelog.html">News</a></li>
<li class="toctree-l1"><a class="reference internal" href="download.html">Download</a></li>
<li class="toctree-l1"><a class="reference internal" href="install.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="help.html">Support</a></li>
<li class="toctree-l1"><a class="reference internal" href="about.html">About</a></li>
</ul>
<h3>External Links</h3>
<ul>
<li><a href="https://github.com/cmake-basis/BASIS">Repository</a></ li>
<li><a href="https://github.com/cmake-basis/BASIS/issues">Issues</a></ li>
</ul>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
© Copyright 2011-12 University of Pennsylvania, 2013-14 Carnegie Mellon University, 2013-16 Andreas Schuh.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.1.
</div>
</body>
</html>