Skip to content

Commit 8d94042

Browse files
committed
Refresh edocs
1 parent 30e7504 commit 8d94042

File tree

5 files changed

+23
-421
lines changed

5 files changed

+23
-421
lines changed

README.md

Lines changed: 5 additions & 202 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,6 @@ $ git clone https://github.com/ubf/ubf-jsonrpc.git ubf_jsonrpc
2323
$ cd ubf_jsonrpc
2424
$ make deps clean compile test</code></pre>
2525

26-
<p>For an alternative recipe with other "features" albeit more complex,
27-
please read further.</p>
2826

2927

3028

@@ -127,76 +125,9 @@ and copied to this repository as the jsf_charset.erl module.</td>
127125
<a href="http://json-rpc.org/">http://json-rpc.org/</a> for full details.</p>
128126

129127

130-
131-
132-
<h2 id="_to_download">To download</h2>
133-
134-
<ol class="arabic">
135-
<li>
136-
<p>
137-
Configure your e-mail and name for Git
138-
</p>
139-
140-
141-
<pre><code>$ git config \--global user.email "[email protected]"
142-
$ git config \--global user.name "Your Name"</code></pre>
143-
144-
</li>
145-
<li>
146-
<p>
147-
Install Repo
148-
</p>
149-
150-
151-
<pre><code>$ mkdir -p ~/bin
152-
$ wget -O - https://dl-ssl.google.com/dl/googlesource/git-repo/repo > ~/bin/repo
153-
$ chmod a+x ~/bin/repo</code></pre>
154-
155-
</li>
156-
<li>
157-
<p>
158-
Create working directory
159-
</p>
160-
161-
162-
<pre><code>$ mkdir working-directory-name
163-
$ cd working-directory-name
164-
$ repo init -u https://github.com/ubf/manifests.git -m ubf-jsonrpc-default.xml</code></pre>
165-
166-
167-
<table><tr>
168-
<td class="icon">
169-
Note
170-
</td>
171-
<td class="content">Your "Git" identity is needed during the init step. Please
172-
enter the name and email of your GitHub account if you have one. Team
173-
members having read-write access are recommended to use "repo init -u
174-
<a href="mailto:[email protected]">[email protected]</a>:ubf/manifests.git -m ubf-jsonrpc-default-rw.xml".</td>
175-
</tr></table>
176-
177-
178-
<table><tr>
179-
<td class="icon">
180-
Tip
181-
</td>
182-
<td class="content">If you want to checkout the latest development version, please
183-
append " -b dev" to the repo init command.</td>
184-
</tr></table>
185-
186-
</li>
187-
<li>
188-
<p>
189-
Download Git repositories
190-
</p>
191-
192-
193-
<pre><code>$ cd working-directory-name
194-
$ repo sync</code></pre>
195-
196-
</li>
197-
</ol>
198-
<p>For further information and help for related tools, please refer to the
199-
following links:</p>
128+
<h3 id="_tools">Tools</h3>
129+
<p>For further information and help for related tools, please refer to
130+
the following links:</p>
200131
<ul>
201132
<li>
202133
<p>
@@ -205,7 +136,7 @@ Erlang - <a href="http://www.erlang.org/">http://www.erlang.org/</a>
205136
<ul>
206137
<li>
207138
<p>
208-
<strong>R14B04 or newer, R16B has been tested most recently</strong>
139+
<strong>R15B01 or newer, 17.0 has been tested most recently</strong>
209140
</p>
210141
</li>
211142
</ul>
@@ -217,12 +148,7 @@ Git - <a href="http://git-scm.com/">http://git-scm.com/</a>
217148
<ul>
218149
<li>
219150
<p>
220-
<strong>Git 1.5.4 or newer, Git 1.8.2 has been tested most recently</strong>
221-
</p>
222-
</li>
223-
<li>
224-
<p>
225-
<em>required for Repo and GitHub</em>
151+
<strong>Git 1.5.4 or newer, Git 1.9.3 has been tested most recently</strong>
226152
</p>
227153
</li>
228154
</ul>
@@ -232,131 +158,8 @@ Git - <a href="http://git-scm.com/">http://git-scm.com/</a>
232158
GitHub - <a href="https://github.com">https://github.com</a>
233159
</p>
234160
</li>
235-
<li>
236-
<p>
237-
Python - <a href="http://www.python.org">http://www.python.org</a>
238-
</p>
239-
<ul>
240-
<li>
241-
<p>
242-
<strong>Python 2.4 or newer, Python 2.7.3 has been tested most recently
243-
(CAUTION: Python 3.x might be too new)</strong>
244-
</p>
245-
</li>
246-
<li>
247-
<p>
248-
<em>required for Repo</em>
249-
</p>
250-
</li>
251161
</ul>
252-
</li>
253-
<li>
254-
<p>
255-
Rebar - <a href="https://github.com/rebar/rebar/wiki">https://github.com/rebar/rebar/wiki</a>
256-
</p>
257-
</li>
258-
<li>
259-
<p>
260-
Repo - <a href="http://source.android.com/source/git-repo.html">http://source.android.com/source/git-repo.html</a>
261-
</p>
262-
</li>
263-
</ul>
264-
265-
266-
267-
<h2 id="_to_build_basic_recipe">To build - basic recipe</h2>
268-
269-
<ol class="arabic">
270-
<li>
271-
<p>
272-
Get and install an erlang system <a href="http://www.erlang.org">http://www.erlang.org</a>
273-
</p>
274-
</li>
275-
<li>
276-
<p>
277-
Build
278-
</p>
279-
280-
281-
<pre><code>$ cd working-directory-name
282-
$ make compile</code></pre>
283162

284-
</li>
285-
<li>
286-
<p>
287-
Run the unit tests
288-
</p>
289-
290-
291-
<pre><code>$ cd working-directory-name
292-
$ make eunit</code></pre>
293-
294-
</li>
295-
</ol>
296-
297-
298-
299-
<h2 id="_to_build_optional_features">To build - optional features</h2>
300-
301-
<ol class="upperalpha">
302-
<li>
303-
<p>
304-
Dialyzer Testing <em>basic recipe</em>
305-
</p>
306-
<ol class="arabic">
307-
<li>
308-
<p>
309-
Build Dialyzer's PLT <em>(required once)</em>
310-
</p>
311-
312-
313-
<pre><code>$ cd working-directory-name
314-
$ make build-plt</code></pre>
315-
316-
317-
<table><tr>
318-
<td class="icon">
319-
Tip
320-
</td>
321-
<td class="content">Check Makefile and dialyzer's documentation for further
322-
information.</td>
323-
</tr></table>
324-
325-
</li>
326-
<li>
327-
<p>
328-
Dialyze with specs
329-
</p>
330-
331-
332-
<pre><code>$ cd working-directory-name
333-
$ make dialyze</code></pre>
334-
335-
336-
<table><tr>
337-
<td class="icon">
338-
Caution
339-
</td>
340-
<td class="content">If you manually run dialyzer with the "-r" option, execute
341-
"make clean compile" first to avoid finding duplicate beam files
342-
underneath rebar's .eunit directory. Check Makefile for further
343-
information.</td>
344-
</tr></table>
345-
346-
</li>
347-
<li>
348-
<p>
349-
Dialyze without specs
350-
</p>
351-
352-
353-
<pre><code>$ cd working-directory-name
354-
$ make dialyze-nospec</code></pre>
355-
356-
</li>
357-
</ol>
358-
</li>
359-
</ol>
360163

361164

362165

0 commit comments

Comments
 (0)