diff --git a/README.md b/README.md index 0f069d9..ee92d9f 100644 --- a/README.md +++ b/README.md @@ -25,8 +25,6 @@ $ git clone https://github.com/ubf/ubf.git ubf $ cd ubf $ make deps clean compile test -

For an alternative recipe with other "features" albeit more complex, -please read further.

@@ -132,76 +130,9 @@ for integrating UBF and ABNF.

for integrating UBF and EEP8.

- - -

To download

- -
    -
  1. -

    -Configure your e-mail and name for Git -

    - - -
    $ git config \--global user.email "you@example.com"
-$ git config \--global user.name "Your Name"
    - -
    2. -
  2. -

    -Install Repo -

    - - -
    $ mkdir -p ~/bin
-$ wget -O - https://dl-ssl.google.com/dl/googlesource/git-repo/repo > ~/bin/repo
-$ chmod a+x ~/bin/repo
    - -
    3. -
  3. -

    -Create working directory -

    - - -
    $ mkdir working-directory-name
-$ cd working-directory-name
-$ repo init -u https://github.com/ubf/manifests.git -m ubf-default.xml
    - - - - - -
    -Note -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 -git@github.com:ubf/manifests.git -m ubf-default-rw.xml".
    - - - - - -
    -Tip -If you want to checkout the latest development version, please -append " -b dev" to the repo init command.
    - -
    4. -
  4. -

    -Download Git repositories -

    - - -
    $ cd working-directory-name
-$ repo sync
    - -
    5. -
-

For further information and help for related tools, please refer to the -following links:

+

Tools

+

For further information and help for related tools, please refer to +the following links:

+ + + + +

What's New in UBF 2.2

+ - -
  • -

    -Rebar - https://github.com/rebar/rebar/wiki -

    -
    • -
  • -

    -Repo - http://source.android.com/source/git-repo.html -

    -
    • - - - - -

    To build - basic recipe

    - -
      -
    1. -

      -Get and install an erlang system http://www.erlang.org -

      -
      2. -
    2. -

      -Build -

      - - -
      $ cd working-directory-name
-$ make compile
      - -
      3. -
    3. -

      -Run the unit tests -

      - - -
      $ cd working-directory-name
-$ make eunit
      - -
      4. -
    - - - -

    To build - optional features

    - -
      -
    1. -

      -Dialyzer Testing basic recipe -

      -
        -
      1. -

        -Build Dialyzer's PLT (required once) -

        - - -
        $ cd working-directory-name
-$ make build-plt
        - - - - - -
        -Tip -Check Makefile and dialyzer's documentation for further -information.
        - -
        2. -
      2. -

        -Dialyze with specs -

        - - -
        $ cd working-directory-name
-$ make dialyze
        - - - - - -
        -Caution -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.
        - -
        3. -
      3. -

        -Dialyze without specs -

        - - -
        $ cd working-directory-name
-$ make dialyze-nospec
        - -
        4. -
      -
      2. -
    2. -

      -To build the Java client and run its encoding/decoding unit test: -

      - - -
      $ cd working-directory-name
-$ make -C lib/ubf/priv/java
      - -
      3. -
    3. -

      -The Python client depends on the "py-interface" library. To clone - and build it, use: -

      - - -
      $ cd working-directory-name
-$ git clone git://repo.or.cz/py_interface.git
-$ cd py_interface
-$ autoconf
-$ make
      - -

      Then install as a normal Python package or run using "env -PYTHONPATH=working-directory-name/py_interface python your-script.py"

      -
      4. -
    @@ -467,11 +267,6 @@ For the above Quick Start Recipe, a Makefile has been added to