-
Notifications
You must be signed in to change notification settings - Fork 1
/
faq.html
308 lines (180 loc) · 9.84 KB
/
faq.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
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>6. Frequently Asked Questions — BeamParticle 0.1.0 documentation</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="author" title="About these documents"
href="about.html"/>
<link rel="index" title="Index"
href="genindex.html"/>
<link rel="search" title="Search" href="search.html"/>
<link rel="top" title="BeamParticle 0.1.0 documentation" href="index.html"/>
<link rel="prev" title="5. Contact" href="contact.html"/>
<script src="_static/js/modernizr.min.js"></script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href="index.html" class="icon icon-home"> BeamParticle
</a>
<div class="version">
0.1.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<p class="caption"><span class="caption-text">Table of Contents</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="about.html">1. About</a></li>
<li class="toctree-l1"><a class="reference internal" href="releasenotes.html">2. Release notes</a></li>
<li class="toctree-l1"><a class="reference internal" href="install.html">3. Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="links.html">4. Important links</a></li>
<li class="toctree-l1"><a class="reference internal" href="contact.html">5. Contact</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">6. Frequently Asked Questions</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#general">6.1. General</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#what-is-the-erlang-setup-for-developer">6.1.1. What is the Erlang setup for developer?</a></li>
<li class="toctree-l3"><a class="reference internal" href="#how-do-i-build-this-project-on-ubuntu">6.1.2. How do I build this project on Ubuntu?</a></li>
<li class="toctree-l3"><a class="reference internal" href="#how-do-i-run-app-in-shell-mode">6.1.3. How do I run app in shell mode?</a></li>
<li class="toctree-l3"><a class="reference internal" href="#how-do-i-run-shell-with-all-the-code-but-not-start-app">6.1.4. How do I run shell with all the code but not start app?</a></li>
<li class="toctree-l3"><a class="reference internal" href="#how-do-i-test-and-create-code-coverage">6.1.5. How do I test and create code coverage?</a></li>
<li class="toctree-l3"><a class="reference internal" href="#how-do-i-run-eunit-tests">6.1.6. How do I run EUnit tests?</a></li>
<li class="toctree-l3"><a class="reference internal" href="#how-do-i-generate-code-documentation">6.1.7. How do I generate code documentation?</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">BeamParticle</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html">Docs</a> »</li>
<li>6. Frequently Asked Questions</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/faq.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="frequently-asked-questions">
<span id="faq"></span><h1>6. Frequently Asked Questions<a class="headerlink" href="#frequently-asked-questions" title="Permalink to this headline">¶</a></h1>
<div class="section" id="general">
<h2>6.1. General<a class="headerlink" href="#general" title="Permalink to this headline">¶</a></h2>
<div class="section" id="what-is-the-erlang-setup-for-developer">
<span id="cite"></span><h3>6.1.1. What is the Erlang setup for developer?<a class="headerlink" href="#what-is-the-erlang-setup-for-developer" title="Permalink to this headline">¶</a></h3>
<ul class="simple">
<li>Erlang/OTP - <a class="reference external" href="http://erlang.org">http://erlang.org</a></li>
<li>Concurrent Programming in erlang - <a class="reference external" href="http://erlang.org/download/erlang-book-part1.pdf">http://erlang.org/download/erlang-book-part1.pdf</a></li>
<li>After some learning of erlang read - <a class="reference external" href="http://www.erlang-in-anger.com/">http://www.erlang-in-anger.com/</a></li>
</ul>
</div>
<div class="section" id="how-do-i-build-this-project-on-ubuntu">
<h3>6.1.2. How do I build this project on Ubuntu?<a class="headerlink" href="#how-do-i-build-this-project-on-ubuntu" title="Permalink to this headline">¶</a></h3>
<p>The following packages must be installed otherwise the NIF (c code) for
eleveldb will fail to build. Note that libssl-dev is required
by snappy (a requirement of eleveldb).</p>
<blockquote>
<div>sudo apt-get install build-essential
sudo apt-get install libssl-dev</div></blockquote>
<p>Clean the project as follows:</p>
<blockquote>
<div>./rebar3 clean beampacket</div></blockquote>
<p>The following command will clean the complete project.</p>
<blockquote>
<div>./rebar3 clean -a</div></blockquote>
<p>Make a release build in the local system.</p>
<blockquote>
<div>./rebar3 release</div></blockquote>
<p>Run a production build in the local system.</p>
<blockquote>
<div>./rebar3 as prod tar</div></blockquote>
</div>
<div class="section" id="how-do-i-run-app-in-shell-mode">
<h3>6.1.3. How do I run app in shell mode?<a class="headerlink" href="#how-do-i-run-app-in-shell-mode" title="Permalink to this headline">¶</a></h3>
<blockquote>
<div>./rebar3 shell –apps beampacket</div></blockquote>
</div>
<div class="section" id="how-do-i-run-shell-with-all-the-code-but-not-start-app">
<h3>6.1.4. How do I run shell with all the code but not start app?<a class="headerlink" href="#how-do-i-run-shell-with-all-the-code-but-not-start-app" title="Permalink to this headline">¶</a></h3>
<blockquote>
<div>erl -pa _build/default/lib/<em>/ebin/</em></div></blockquote>
</div>
<div class="section" id="how-do-i-test-and-create-code-coverage">
<h3>6.1.5. How do I test and create code coverage?<a class="headerlink" href="#how-do-i-test-and-create-code-coverage" title="Permalink to this headline">¶</a></h3>
<p><strong>TODO</strong></p>
</div>
<div class="section" id="how-do-i-run-eunit-tests">
<h3>6.1.6. How do I run EUnit tests?<a class="headerlink" href="#how-do-i-run-eunit-tests" title="Permalink to this headline">¶</a></h3>
<p><strong>TODO</strong></p>
</div>
<div class="section" id="how-do-i-generate-code-documentation">
<h3>6.1.7. How do I generate code documentation?<a class="headerlink" href="#how-do-i-generate-code-documentation" title="Permalink to this headline">¶</a></h3>
<p>The code documentation is generated via <cite>edoc<http://erlang.org/doc/apps/edoc/chapter.html></cite> as follows:</p>
<blockquote>
<div>./rebar3 edoc</div></blockquote>
<p>The output is generated in doc/ subfolder.</p>
</div>
</div>
</div>
</div>
<div class="articleComments">
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="contact.html" class="btn btn-neutral" title="5. Contact" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2017, Neeraj Sharma.
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'0.1.0',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</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>
<script type="text/javascript" src="_static/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.StickyNav.enable();
});
</script>
</body>
</html>