summaryrefslogtreecommitdiff
path: root/BUILD.md
diff options
context:
space:
mode:
authorUlf Wiger <ulf@feuerlabs.com>2016-01-27 16:28:46 +0100
committerUlf Wiger <ulf@feuerlabs.com>2016-02-09 21:46:58 +0100
commit646154b32105811b1f34fc5612e87e694c56b522 (patch)
tree25b1c0e12afed4420769984394dfcf2277e19818 /BUILD.md
parent83e57a5094f212caca239b33f4b4e120e10c8fa9 (diff)
downloadrvi_core-646154b32105811b1f34fc5612e87e694c56b522.tar.gz
ongoing update of docs to 0.5.0
Diffstat (limited to 'BUILD.md')
-rw-r--r--BUILD.md77
1 files changed, 45 insertions, 32 deletions
diff --git a/BUILD.md b/BUILD.md
index 9d7be37..87ac02a 100644
--- a/BUILD.md
+++ b/BUILD.md
@@ -1,19 +1,19 @@
-Copyright (C) 2014-2015, Jaguar Land Rover
+Copyright (C) 2014-2016, Jaguar Land Rover
This document is licensed under Creative Commons
Attribution-ShareAlike 4.0 International.
-**Version 0.4.0**
+**Version 0.5.0**
# BUILD INSTRUCTIONS FOR RVI #
This document describes the build process for the RVI project on an
-Ubuntu 14.01 Linux machine.
+Ubuntu 14.04 Linux machine.
Please see ```README.md``` for a general description of the project
and its structure.
-Please see ```CONFIGURE.md``` for details on cofniguring and launching
+Please see ```CONFIGURE.md``` for details on configuring and launching
the system once it has been built.
The first milestone of the RVI project is the HVAC demo. Please see
@@ -31,7 +31,7 @@ Please note that the configuraiton process, described in
# PREREQUISITES #
-1. The Ubuntu 14.01 system have the latest updates installed.
+1. The Ubuntu 14.04 system have the latest updates installed.
2. The user can gain root access to install packages.
3. There is at least 5GB of space availabled for packages and code.
@@ -46,8 +46,17 @@ Grade Linux repositories where the code resides:
## INSTALL ERLANG ##
-Install Erlang R16B03, or a later R16 release:
+Install Erlang 18.2, or a later version 18 release:
+Tested packages of the latest versions of Erlang can be downloaded from [packages.erlang-solutions.com](https://www.erlang-solutions.com/resources/download.html)
+
+Add the following line to your /etc/apt/sources.list
+
+ deb http://packages.erlang-solutions.com/ubuntu trusty contrib
+
+Update and install erlang
+
+ sudo apt-get update
sudo apt-get install erlang
@@ -60,18 +69,13 @@ to the build system.
The clone will be downloaded into a newly created ```rvi_core``` subdirectory.
+## BUILD THE RVI SYSTEM ##
-## RETRIEVE ADDITIONAL CODE DEPENDENCIES ##
-
-Move into the newly created ```rvi_core``` directory where the code resides.
-
- cd rvi_core
+Run ```make``` to build the dependency code in ```deps``` and the
+top level project in the ```rvi``` directory.
-Run ```make deps``` to pull all necessary repositories into the ```deps```
-subdirectory under the ```rvi``` directory:
+ make compile
- make deps
-
The local ```rebar``` command is used to retrieve the dependencies. See
```rebar.config``` and ```deps/*/rebar.config``` for a list of
dependencies.
@@ -79,25 +83,34 @@ dependencies.
See the [rebar](https://github.com/basho/rebar) project for a detailed
description of the rebar Erlang build tool.
-
-## BUILD THE RVI SYSTEM ##
-
-Run ```make``` to build the dependency code in ```deps``` and the
-top level project in the ```rvi``` directory.
-
- make compile
-
-The following warnings are expected, and are not a failure indication:
-
- .../exo_ssh.erl:18: Warning: undefined callback function code_change/3 (behaviour 'ssh_channel')
- ...
- .../bert_challenge.erl:223: Warning: crypto:sha/1 is deprecated and will be removed in in a future release; use crypto:hash/2
- ...
- .../bert_challenge.erl:230: Warning: crypto:sha/1 is deprecated and will be removed in in a future release; use crypto:hash/2
+ Expected output:
+ $ make
+ ./rebar get-deps
+ ==> goldrush (get-deps)
+ ==> lager (get-deps)
+ ==> src (get-deps)
+ ==> ale (get-deps)
+ ==> src (get-deps)
+ ...
+ ./rebar compile
+ ==> goldrush (compile)
+ Compiled src/glc.erl
+ Compiled src/glc_lib.erl
+ Compiled src/glc_code.erl
...
- .../authorize_rpc.erl:31: Warning: function get_certificate_body/2 is unused
+ /.../rvi_core/deps/exo/src/exo_ssh.erl:18: Warning: undefined callback function code_change/3 (behaviour 'ssh_channel')
+ /.../rvi_core/deps/exo/src/exo_ssh.erl:18: Warning: undefined callback function handle_call/3 (behaviour 'ssh_channel')
+ ...
+ cp deps/setup/setup_gen scripts/
+ (cd components/authorize && make escript)
+ ERL_LIBS=/.../rvi_core/components/authorize/..:/..../jlr/rvi_core/components/authorize/../../deps ./rebar escriptize
+ ==> authorize (escriptize)
+ cp components/authorize/author scripts/
+ $
+
+Some warnings are expected, and are usually not a failure indication:
-The compiled code is available under ```ebin/``` and ```deps/*/ebin```.
+The compiled code is available under ```ebin/```, ```components/*/ebin``` and ```deps/*/ebin```.
## CREATE A RELEASE ##