erl-dev/quickstart.html at master · humasect/erl-dev · GitHub

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
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
               "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml"
lang="en" xml:lang="en">
<head>
<title>/Zen Server Quick Start/</title>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"/>
<meta name="generator" content="Org-mode"/>
<meta name="generated" content="2010-09-23 21:44:44 MDT"/>
<meta name="author" content="Lyndon Tremblay"/>
<meta name="description" content=""/>
<meta name="keywords" content=""/>
<style type="text/css">
 <!--/*--><![CDATA[/*><!--*/
  html { font-family: Times, serif; font-size: 12pt; }
  .title  { text-align: center; }
  .todo   { color: red; }
  .done   { color: green; }
  .tag    { background-color: #add8e6; font-weight:normal }
  .target { }
  .timestamp { color: #bebebe; }
  .timestamp-kwd { color: #5f9ea0; }
  p.verse { margin-left: 3% }
  pre {
	border: 1pt solid #AEBDCC;
	background-color: #F3F5F7;
	padding: 5pt;
	font-family: courier, monospace;
        font-size: 90%;
        overflow:auto;
  }
  table { border-collapse: collapse; }
  td, th { vertical-align: top; }
  dt { font-weight: bold; }
  div.figure { padding: 0.5em; }
  div.figure p { text-align: center; }
  textarea { overflow-x: auto; }
  .linenr { font-size:smaller }
  .code-highlighted {background-color:#ffff00;}
  .org-info-js_info-navigation { border-style:none; }
  #org-info-js_console-label { font-size:10px; font-weight:bold;
                               white-space:nowrap; }
  .org-info-js_search-highlight {background-color:#ffff00; color:#000000;
                                 font-weight:bold; }
  /*]]>*/-->
</style>
<script type="text/javascript">
<!--/*--><![CDATA[/*><!--*/
 function CodeHighlightOn(elem, id)
 {
   var target = document.getElementById(id);
   if(null != target) {
     elem.cacheClassElem = elem.className;
     elem.cacheClassTarget = target.className;
     target.className = "code-highlighted";
     elem.className   = "code-highlighted";
   }
 }
 function CodeHighlightOff(elem, id)
 {
   var target = document.getElementById(id);
   if(elem.cacheClassElem)
     elem.className = elem.cacheClassElem;
   if(elem.cacheClassTarget)
     target.className = elem.cacheClassTarget;
 }
/*]]>*///-->
</script>
</head>
<body>
<div id="content">

<h1 class="title"><i>Zen Server Quick Start</i></h1>


<pre class="src src-none">    /==================================\
 ====                                  ====
/     Zen Social Adventure Game Server     \
====   ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~   ====
\    Copyright (C) 2010 Lyndon Tremblay    /
 ====                                  ====
    \==================================/
</pre>


<div id="outline-container-1" class="outline-2">
<h2 id="sec-1">Running the server </h2>
<div class="outline-text-2" id="text-1">


<ul>
<li>
To start the Erlang shell:

<pre class="example">
./erl-dev.sh
</pre>


</li>
<li>
To run the server from there:

<pre class="example">
zen:start_all().
</pre>


</li>
<li>
To see other commands:

<pre class="example">
help().
</pre>


</li>
<li>
Optionally generate the Edoc documentation:

<pre class="example">
mkdoc(zen).
</pre>


</li>
<li>
Which ends up at:

<pre class="example">
./priv/www/edoc/
http://localhost:8000/edoc/
</pre>


</li>
</ul>
</div>

</div>

<div id="outline-container-2" class="outline-2">
<h2 id="sec-2">Setting Up Content </h2>
<div class="outline-text-2" id="text-2">


<ul>
<li>
Now, make the full documentation with Emacs. Open and evaluate:

<pre class="example">
./org/export.el
</pre>


<pre class="example">
M-x eval-buffer
  &lt;or&gt;
Emacs-Lisp &gt; Evaluate Buffer
</pre>


</li>
<li>
Then:

<pre class="example">
s-o
 &lt;or&gt;
M-: (zen-publish)
</pre>


</li>
<li>
And finally, read and aborb it:

<pre class="example">
./priv/www/dev/
http://localhost:8000/dev/
</pre>


</li>
</ul>
</div>
</div>
<div id="postamble">
<p class="author"> Author: Lyndon Tremblay
</p>
<p class="date"> Date: 2010-09-23 21:44:44 MDT</p>
<p class="creator">HTML generated by org-mode 7.01h in emacs 23</p>
</div>
</div>
</body>
</html>