
############
Quick Start
############

[dependencies]
    libpthread
    libpthread-stubs-dev - 0.3-r0
    openssl-dev - 1.0.0i-r0.2 (for libcrypto)
    libuuid-dev - 2.21-r5 (aka libuuid-devel)
    libmodbus-3.0.3.tar.gz  
    zeromq-4.0.1.tar.gz
    czmq-2.0.2.tar.gz  

[install tar.gz distribution]
# scp tar archive to beaglebone or linux host
    tar xzvf xfoce-<version>.tar.gz
    cd xfoce-<version>
    . src/scripts/xfenv

[install from hg repo]
# xfoce primary repo at bitbucket:
# https://klheadley@bitbucket.org/klheadley/xfoce

    hg clone <xfoce-repo>
    cd xfoce
    ./bootstrap

# boostrap calls
    libtoolize -f
    aclocal
    autoconf
    autoreconf
    automake --add-missing

# If building on bbone target
# you will likely need to change
# paths in configure.ac
# comment/uncomment as needed:

# CENTOS
# CPPFLAGS="-I/usr/local/include/modbus -I/usr/include"
# LDFLAGS="-L/usr/lib/i386-linux-gnu -L/usr/local/lib"
# Angstrom 3.8 kernel
# CPPFLAGS="-I/usr/include/modbus -I/usr/include"
# LDFLAGS="-L/usr/lib/i386-linux-gnu -L/usr/lib -L/usr/local/lib"

# newer versions of autotools (e.g. on 3.8 kernel)
# are more recent than the verion used to make the distribution.
# It is likely to work OK as long as the Makefile.am's' don't change.
# then, it may be necessary to uncomment the lines indicated in
# configure.ac, re-run bootstrap, and run make -k on the initial rebuild.

[build]
    ./configure
    make

# currently recommend NOT installing
# but working from build directory
    (sudo make install)


[configure xfoce]
# may need to start virtual serial ports, e.g.
#   src/scripts/digicfg -c init -a <digi-addr> -i <dev-prefix>
#   sudo servicectl start socatd\@service
#
# xfoce config file...
# source and stream IDs...
# proxies...

[run]
    cd /path/to/XFHOME
    . src/scripts/xfenv
    xsvc start sbr
    xsvc start sds -p
    xsvc start gw -f <path/to/config>

[management]
# apps    : XFHOME/src/gateway/apps
# scripts : XFHOME/src/scripts
# logs    : XFHOME/logs
# archive : XFHOME/arch
...

############
Directories
############
XFHOME/arch
XFHOME/logs
XFHOME/src/scripts
XFHOME/src/gateway/apps
XFHOME/doc

#######
Source
#######
src/include
src/include/drivers
src/scripts
src/gateway
src/gateway/apps
src/gateway/beaglebone
src/gateway/contrib
src/gateway/core
src/gateway/drivers
src/gateway/rootfs
src/gateway/snode
src/gateway/test
src/oebb
src/www

#######
Build
#######
make [help arch]
make [clean dclean]
make [all xfoce doc]
make [dist install]
- build/release/xfoce-src-ver.tar.gz
- build/release/xfoce-bin-ver.tar.gz

##########
Utilities
##########

[ name ]
path/to/util
path/to/related/files
- description
- use/options/example 

