mirror of
https://github.com/ubf/ubf.git
synced 2026-04-15 17:25:29 +00:00
Refresh edocs
This commit is contained in:
Joseph Wayne Norton
245
README.md
245
README.md
@@ -25,8 +25,6 @@ $ git clone https://github.com/ubf/ubf.git ubf
|
||||
$ cd ubf
|
||||
$ make deps clean compile test</code></pre>
|
||||
|
||||
<p>For an alternative recipe with other "features" albeit more complex,
|
||||
please read further.</p>
|
||||
|
||||
|
||||
|
||||
@@ -132,76 +130,9 @@ for integrating UBF and ABNF.</p>
|
||||
for integrating UBF and EEP8.</p>
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 id="_to_download">To download</h2>
|
||||
|
||||
<ol class="arabic">
|
||||
<li>
|
||||
<p>
|
||||
Configure your e-mail and name for Git
|
||||
</p>
|
||||
|
||||
|
||||
<pre><code>$ git config \--global user.email "you@example.com"
|
||||
$ git config \--global user.name "Your Name"</code></pre>
|
||||
|
||||
</li>
|
||||
<li>
|
||||
<p>
|
||||
Install Repo
|
||||
</p>
|
||||
|
||||
|
||||
<pre><code>$ mkdir -p ~/bin
|
||||
$ wget -O - https://dl-ssl.google.com/dl/googlesource/git-repo/repo > ~/bin/repo
|
||||
$ chmod a+x ~/bin/repo</code></pre>
|
||||
|
||||
</li>
|
||||
<li>
|
||||
<p>
|
||||
Create working directory
|
||||
</p>
|
||||
|
||||
|
||||
<pre><code>$ mkdir working-directory-name
|
||||
$ cd working-directory-name
|
||||
$ repo init -u https://github.com/ubf/manifests.git -m ubf-default.xml</code></pre>
|
||||
|
||||
|
||||
<table><tr>
|
||||
<td class="icon">
|
||||
Note
|
||||
</td>
|
||||
<td class="content">Your "Git" identity is needed during the init step. Please
|
||||
enter the name and email of your GitHub account if you have one. Team
|
||||
members having read-write access are recommended to use "repo init -u
|
||||
<a href="mailto:git@github.com">git@github.com</a>:ubf/manifests.git -m ubf-default-rw.xml".</td>
|
||||
</tr></table>
|
||||
|
||||
|
||||
<table><tr>
|
||||
<td class="icon">
|
||||
Tip
|
||||
</td>
|
||||
<td class="content">If you want to checkout the latest development version, please
|
||||
append " -b dev" to the repo init command.</td>
|
||||
</tr></table>
|
||||
|
||||
</li>
|
||||
<li>
|
||||
<p>
|
||||
Download Git repositories
|
||||
</p>
|
||||
|
||||
|
||||
<pre><code>$ cd working-directory-name
|
||||
$ repo sync</code></pre>
|
||||
|
||||
</li>
|
||||
</ol>
|
||||
<p>For further information and help for related tools, please refer to the
|
||||
following links:</p>
|
||||
<h3 id="_tools">Tools</h3>
|
||||
<p>For further information and help for related tools, please refer to
|
||||
the following links:</p>
|
||||
<ul>
|
||||
<li>
|
||||
<p>
|
||||
@@ -210,7 +141,7 @@ Erlang - <a href="http://www.erlang.org/">http://www.erlang.org/</a>
|
||||
<ul>
|
||||
<li>
|
||||
<p>
|
||||
<strong>R14B04 or newer, R16B has been tested most recently</strong>
|
||||
<strong>R15B01 or newer, 17.0 has been tested most recently</strong>
|
||||
</p>
|
||||
</li>
|
||||
</ul>
|
||||
@@ -222,12 +153,7 @@ Git - <a href="http://git-scm.com/">http://git-scm.com/</a>
|
||||
<ul>
|
||||
<li>
|
||||
<p>
|
||||
<strong>Git 1.5.4 or newer, Git 1.8.2 has been tested most recently</strong>
|
||||
</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>
|
||||
<em>required for Repo and GitHub</em>
|
||||
<strong>Git 1.5.4 or newer, Git 1.9.3 has been tested most recently</strong>
|
||||
</p>
|
||||
</li>
|
||||
</ul>
|
||||
@@ -237,157 +163,31 @@ Git - <a href="http://git-scm.com/">http://git-scm.com/</a>
|
||||
GitHub - <a href="https://github.com">https://github.com</a>
|
||||
</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>
|
||||
Python - <a href="http://www.python.org">http://www.python.org</a>
|
||||
</p>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 id="_what_s_new_in_ubf_2_2">What's New in UBF 2.2</h2>
|
||||
|
||||
<ul>
|
||||
<li>
|
||||
<p>
|
||||
<strong>Python 2.4 or newer, Python 2.7.3 has been tested most recently
|
||||
(CAUTION: Python 3.x might be too new)</strong>
|
||||
Added support for 17.0. Removed support for R14.
|
||||
</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>
|
||||
<em>required for Repo</em>
|
||||
QuickCheck and PropEr related features and tests are unsupported
|
||||
until further notice.
|
||||
</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>
|
||||
Deprecate repo tool.
|
||||
</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p>
|
||||
Rebar - <a href="https://github.com/rebar/rebar/wiki">https://github.com/rebar/rebar/wiki</a>
|
||||
</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>
|
||||
Repo - <a href="http://source.android.com/source/git-repo.html">http://source.android.com/source/git-repo.html</a>
|
||||
</p>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
<h2 id="_to_build_basic_recipe">To build - basic recipe</h2>
|
||||
|
||||
<ol class="arabic">
|
||||
<li>
|
||||
<p>
|
||||
Get and install an erlang system <a href="http://www.erlang.org">http://www.erlang.org</a>
|
||||
</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>
|
||||
Build
|
||||
</p>
|
||||
|
||||
|
||||
<pre><code>$ cd working-directory-name
|
||||
$ make compile</code></pre>
|
||||
|
||||
</li>
|
||||
<li>
|
||||
<p>
|
||||
Run the unit tests
|
||||
</p>
|
||||
|
||||
|
||||
<pre><code>$ cd working-directory-name
|
||||
$ make eunit</code></pre>
|
||||
|
||||
</li>
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
<h2 id="_to_build_optional_features">To build - optional features</h2>
|
||||
|
||||
<ol class="upperalpha">
|
||||
<li>
|
||||
<p>
|
||||
Dialyzer Testing <em>basic recipe</em>
|
||||
</p>
|
||||
<ol class="arabic">
|
||||
<li>
|
||||
<p>
|
||||
Build Dialyzer's PLT <em>(required once)</em>
|
||||
</p>
|
||||
|
||||
|
||||
<pre><code>$ cd working-directory-name
|
||||
$ make build-plt</code></pre>
|
||||
|
||||
|
||||
<table><tr>
|
||||
<td class="icon">
|
||||
Tip
|
||||
</td>
|
||||
<td class="content">Check Makefile and dialyzer's documentation for further
|
||||
information.</td>
|
||||
</tr></table>
|
||||
|
||||
</li>
|
||||
<li>
|
||||
<p>
|
||||
Dialyze with specs
|
||||
</p>
|
||||
|
||||
|
||||
<pre><code>$ cd working-directory-name
|
||||
$ make dialyze</code></pre>
|
||||
|
||||
|
||||
<table><tr>
|
||||
<td class="icon">
|
||||
Caution
|
||||
</td>
|
||||
<td class="content">If you manually run dialyzer with the "-r" option, execute
|
||||
"make clean compile" first to avoid finding duplicate beam files
|
||||
underneath rebar's .eunit directory. Check Makefile for further
|
||||
information.</td>
|
||||
</tr></table>
|
||||
|
||||
</li>
|
||||
<li>
|
||||
<p>
|
||||
Dialyze without specs
|
||||
</p>
|
||||
|
||||
|
||||
<pre><code>$ cd working-directory-name
|
||||
$ make dialyze-nospec</code></pre>
|
||||
|
||||
</li>
|
||||
</ol>
|
||||
</li>
|
||||
<li>
|
||||
<p>
|
||||
To build the Java client and run its encoding/decoding unit test:
|
||||
</p>
|
||||
|
||||
|
||||
<pre><code>$ cd working-directory-name
|
||||
$ make -C lib/ubf/priv/java</code></pre>
|
||||
|
||||
</li>
|
||||
<li>
|
||||
<p>
|
||||
The Python client depends on the "py-interface" library. To clone
|
||||
and build it, use:
|
||||
</p>
|
||||
|
||||
|
||||
<pre><code>$ cd working-directory-name
|
||||
$ git clone git://repo.or.cz/py_interface.git
|
||||
$ cd py_interface
|
||||
$ autoconf
|
||||
$ make</code></pre>
|
||||
|
||||
<p>Then install as a normal Python package or run using "env
|
||||
PYTHONPATH=working-directory-name/py_interface python your-script.py"</p>
|
||||
</li>
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
@@ -467,11 +267,6 @@ For the above Quick Start Recipe, a Makefile has been added to
|
||||
<ul>
|
||||
<li>
|
||||
<p>
|
||||
QuickCheck/PropEr/Triq tests
|
||||
</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>
|
||||
Transport Protocols
|
||||
</p>
|
||||
<ul>
|
||||
|
||||
245
doc/README.md
245
doc/README.md
@@ -25,8 +25,6 @@ $ git clone https://github.com/ubf/ubf.git ubf
|
||||
$ cd ubf
|
||||
$ make deps clean compile test</code></pre>
|
||||
|
||||
<p>For an alternative recipe with other "features" albeit more complex,
|
||||
please read further.</p>
|
||||
|
||||
|
||||
|
||||
@@ -132,76 +130,9 @@ for integrating UBF and ABNF.</p>
|
||||
for integrating UBF and EEP8.</p>
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 id="_to_download">To download</h2>
|
||||
|
||||
<ol class="arabic">
|
||||
<li>
|
||||
<p>
|
||||
Configure your e-mail and name for Git
|
||||
</p>
|
||||
|
||||
|
||||
<pre><code>$ git config \--global user.email "you@example.com"
|
||||
$ git config \--global user.name "Your Name"</code></pre>
|
||||
|
||||
</li>
|
||||
<li>
|
||||
<p>
|
||||
Install Repo
|
||||
</p>
|
||||
|
||||
|
||||
<pre><code>$ mkdir -p ~/bin
|
||||
$ wget -O - https://dl-ssl.google.com/dl/googlesource/git-repo/repo > ~/bin/repo
|
||||
$ chmod a+x ~/bin/repo</code></pre>
|
||||
|
||||
</li>
|
||||
<li>
|
||||
<p>
|
||||
Create working directory
|
||||
</p>
|
||||
|
||||
|
||||
<pre><code>$ mkdir working-directory-name
|
||||
$ cd working-directory-name
|
||||
$ repo init -u https://github.com/ubf/manifests.git -m ubf-default.xml</code></pre>
|
||||
|
||||
|
||||
<table><tr>
|
||||
<td class="icon">
|
||||
Note
|
||||
</td>
|
||||
<td class="content">Your "Git" identity is needed during the init step. Please
|
||||
enter the name and email of your GitHub account if you have one. Team
|
||||
members having read-write access are recommended to use "repo init -u
|
||||
<a href="mailto:git@github.com">git@github.com</a>:ubf/manifests.git -m ubf-default-rw.xml".</td>
|
||||
</tr></table>
|
||||
|
||||
|
||||
<table><tr>
|
||||
<td class="icon">
|
||||
Tip
|
||||
</td>
|
||||
<td class="content">If you want to checkout the latest development version, please
|
||||
append " -b dev" to the repo init command.</td>
|
||||
</tr></table>
|
||||
|
||||
</li>
|
||||
<li>
|
||||
<p>
|
||||
Download Git repositories
|
||||
</p>
|
||||
|
||||
|
||||
<pre><code>$ cd working-directory-name
|
||||
$ repo sync</code></pre>
|
||||
|
||||
</li>
|
||||
</ol>
|
||||
<p>For further information and help for related tools, please refer to the
|
||||
following links:</p>
|
||||
<h3 id="_tools">Tools</h3>
|
||||
<p>For further information and help for related tools, please refer to
|
||||
the following links:</p>
|
||||
<ul>
|
||||
<li>
|
||||
<p>
|
||||
@@ -210,7 +141,7 @@ Erlang - <a href="http://www.erlang.org/">http://www.erlang.org/</a>
|
||||
<ul>
|
||||
<li>
|
||||
<p>
|
||||
<strong>R14B04 or newer, R16B has been tested most recently</strong>
|
||||
<strong>R15B01 or newer, 17.0 has been tested most recently</strong>
|
||||
</p>
|
||||
</li>
|
||||
</ul>
|
||||
@@ -222,12 +153,7 @@ Git - <a href="http://git-scm.com/">http://git-scm.com/</a>
|
||||
<ul>
|
||||
<li>
|
||||
<p>
|
||||
<strong>Git 1.5.4 or newer, Git 1.8.2 has been tested most recently</strong>
|
||||
</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>
|
||||
<em>required for Repo and GitHub</em>
|
||||
<strong>Git 1.5.4 or newer, Git 1.9.3 has been tested most recently</strong>
|
||||
</p>
|
||||
</li>
|
||||
</ul>
|
||||
@@ -237,157 +163,31 @@ Git - <a href="http://git-scm.com/">http://git-scm.com/</a>
|
||||
GitHub - <a href="https://github.com">https://github.com</a>
|
||||
</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>
|
||||
Python - <a href="http://www.python.org">http://www.python.org</a>
|
||||
</p>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 id="_what_s_new_in_ubf_2_2">What's New in UBF 2.2</h2>
|
||||
|
||||
<ul>
|
||||
<li>
|
||||
<p>
|
||||
<strong>Python 2.4 or newer, Python 2.7.3 has been tested most recently
|
||||
(CAUTION: Python 3.x might be too new)</strong>
|
||||
Added support for 17.0. Removed support for R14.
|
||||
</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>
|
||||
<em>required for Repo</em>
|
||||
QuickCheck and PropEr related features and tests are unsupported
|
||||
until further notice.
|
||||
</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>
|
||||
Deprecate repo tool.
|
||||
</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p>
|
||||
Rebar - <a href="https://github.com/rebar/rebar/wiki">https://github.com/rebar/rebar/wiki</a>
|
||||
</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>
|
||||
Repo - <a href="http://source.android.com/source/git-repo.html">http://source.android.com/source/git-repo.html</a>
|
||||
</p>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
<h2 id="_to_build_basic_recipe">To build - basic recipe</h2>
|
||||
|
||||
<ol class="arabic">
|
||||
<li>
|
||||
<p>
|
||||
Get and install an erlang system <a href="http://www.erlang.org">http://www.erlang.org</a>
|
||||
</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>
|
||||
Build
|
||||
</p>
|
||||
|
||||
|
||||
<pre><code>$ cd working-directory-name
|
||||
$ make compile</code></pre>
|
||||
|
||||
</li>
|
||||
<li>
|
||||
<p>
|
||||
Run the unit tests
|
||||
</p>
|
||||
|
||||
|
||||
<pre><code>$ cd working-directory-name
|
||||
$ make eunit</code></pre>
|
||||
|
||||
</li>
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
<h2 id="_to_build_optional_features">To build - optional features</h2>
|
||||
|
||||
<ol class="upperalpha">
|
||||
<li>
|
||||
<p>
|
||||
Dialyzer Testing <em>basic recipe</em>
|
||||
</p>
|
||||
<ol class="arabic">
|
||||
<li>
|
||||
<p>
|
||||
Build Dialyzer's PLT <em>(required once)</em>
|
||||
</p>
|
||||
|
||||
|
||||
<pre><code>$ cd working-directory-name
|
||||
$ make build-plt</code></pre>
|
||||
|
||||
|
||||
<table><tr>
|
||||
<td class="icon">
|
||||
Tip
|
||||
</td>
|
||||
<td class="content">Check Makefile and dialyzer's documentation for further
|
||||
information.</td>
|
||||
</tr></table>
|
||||
|
||||
</li>
|
||||
<li>
|
||||
<p>
|
||||
Dialyze with specs
|
||||
</p>
|
||||
|
||||
|
||||
<pre><code>$ cd working-directory-name
|
||||
$ make dialyze</code></pre>
|
||||
|
||||
|
||||
<table><tr>
|
||||
<td class="icon">
|
||||
Caution
|
||||
</td>
|
||||
<td class="content">If you manually run dialyzer with the "-r" option, execute
|
||||
"make clean compile" first to avoid finding duplicate beam files
|
||||
underneath rebar's .eunit directory. Check Makefile for further
|
||||
information.</td>
|
||||
</tr></table>
|
||||
|
||||
</li>
|
||||
<li>
|
||||
<p>
|
||||
Dialyze without specs
|
||||
</p>
|
||||
|
||||
|
||||
<pre><code>$ cd working-directory-name
|
||||
$ make dialyze-nospec</code></pre>
|
||||
|
||||
</li>
|
||||
</ol>
|
||||
</li>
|
||||
<li>
|
||||
<p>
|
||||
To build the Java client and run its encoding/decoding unit test:
|
||||
</p>
|
||||
|
||||
|
||||
<pre><code>$ cd working-directory-name
|
||||
$ make -C lib/ubf/priv/java</code></pre>
|
||||
|
||||
</li>
|
||||
<li>
|
||||
<p>
|
||||
The Python client depends on the "py-interface" library. To clone
|
||||
and build it, use:
|
||||
</p>
|
||||
|
||||
|
||||
<pre><code>$ cd working-directory-name
|
||||
$ git clone git://repo.or.cz/py_interface.git
|
||||
$ cd py_interface
|
||||
$ autoconf
|
||||
$ make</code></pre>
|
||||
|
||||
<p>Then install as a normal Python package or run using "env
|
||||
PYTHONPATH=working-directory-name/py_interface python your-script.py"</p>
|
||||
</li>
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
@@ -467,11 +267,6 @@ For the above Quick Start Recipe, a Makefile has been added to
|
||||
<ul>
|
||||
<li>
|
||||
<p>
|
||||
QuickCheck/PropEr/Triq tests
|
||||
</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>
|
||||
Transport Protocols
|
||||
</p>
|
||||
<ul>
|
||||
|
||||
@@ -1,4 +1,3 @@
|
||||
%% encoding: UTF-8
|
||||
{application,ubf}.
|
||||
{packages,[]}.
|
||||
{modules,[contract_driver,contract_lex,contract_manager,contract_manager_tlog,
|
||||
|
||||
Reference in New Issue
Block a user