Changes between Version 9 and Version 10 of GettingStartedGuide


Ignore:
Timestamp:
18/10/17 14:12:51 (16 months ago)
Author:
thofmann
Comment:

minor updates (yum instead of dnf, version, update urls, -jnproc)

Legend:

Unmodified
Added
Removed
Modified

  • GettingStartedGuide

    v9 v10  
    44 
    55== Requirements == 
    6 Fawkes focuses on development for [http://www.linux.org Linux-based systems] in general, and [http://www.fedoraproject.org Fedora Linux] and [http://www.centos.org CentOS]/[http://www.redhat.com Red Hat Enterprise Linux] in particular. Other distributions like [http://www.ubuntu.com Ubuntu] and [http://www.debian.org Debian] have been used successfully, but may require a little more work. The Fawkes Development team maintains many required packages within Fedora, and therefore coverage is best there. Fawkes can also be compiled and used on [http://www.freebsd.org FreeBSD], but some hardware plugins may not be available. 
     6Fawkes focuses on development for [https://www.linux.org Linux-based systems] in general, and [https://www.fedoraproject.org Fedora Linux] and [https://www.centos.org CentOS]/[https://www.redhat.com Red Hat Enterprise Linux] in particular. Other distributions like [https://www.ubuntu.com Ubuntu] and [https://www.debian.org Debian] have been used successfully, but may require a little more work. The Fawkes Development team maintains many required packages within Fedora, and therefore coverage is best there. Fawkes can also be compiled and used on [https://www.freebsd.org FreeBSD], but some hardware plugins may not be available. 
    77 
    88Fawkes needs a few other software libraries that have to be installed on the development system. It is our declared goal to minimize this set of libraries, but libraries allow for extending Fawkes' functionality without reinventing the wheel and lowering the amount of code to write, verify, and maintain. We do not package any 3rd party libraries in the Fawkes source tree, but rely on the target system to provide those libraries. This way the source tree remains sleek and we exploit the working force of the fine people packaging software for their favorite operating system. 
    … …  
    1616This method is currently supported on Fedora. Fawkes has been accepted as a Fedora package and can be installed either via the graphical package install utility or via yum on the command line. Install the {{{fawkes}}} package to get a useful base system. To do this on the command line execute ''as root'': 
    1717{{{ 
    18 yum install fawkes 
     18dnf install fawkes 
    1919}}} 
    2020''Note'': If you plan to compile Fawkes from source, this method can be used to get the largest set of dependencies available on Fawkes by installing the {{{fawkes-devenv}}} package instead of {{{fawkes}}}. As its dependencies this package will pull in everything required and recommended to build Fawkes. 
    … …  
    2525You can also go to the [http://www.fawkesrobotics.org/download/ download page] and get the latest release tarball. Afterwards unpack it with the following command, adapting the version number as necessary. 
    2626{{{ 
    27 tar xfj fawkes-0.4.1.tar.gz 
     27tar xfj fawkes-1.0.1.tar.gz 
    2828}}} 
    2929Continue below at [#CompilingFawkes Compiling Fawkes]. 
    … …  
    4141Make sure you have installed at least the minimum requirements, better even the recommended dependencies or as much as possible listed at FawkesDependencies. On Fedora read in the section [#System-widebinaryinstallation system-wide binary installation] about the fawkes-devenv package to achieve this easily, without having a full binary installation otherwise. We additionally recommend using [http://ccache.samba.org/ ccache], a tool that will create an object cache and which can tremendously speedup consecutive compilation runs during development. 
    4242 
    43 Afterwards go to your Fawkes source directory, named either fawkes-0.4.1 (for tarball installation, version may differ, of course) or fawkes (for git checkout). Then execute the following make command: 
     43Afterwards go to your Fawkes source directory, named either fawkes-1.0.1 (for tarball installation, version may differ, of course) or fawkes (for git checkout). Then execute the following make command: 
    4444{{{ 
    45 make -j2 clean all gui 
     45make -j`nproc` clean all gui 
    4646}}} 
    47 This will build everything that can be built. The {{{-j2}}} parameter assumes that you have a dual core machine and will cause parallel compilation with two job clients. On a single-core machine omit this option. If you have more cores increase this accordingly. 
     47This will build everything that can be built. The {{{-j`nproc`}}} parameter runs a parallel compilation that uses all your available cores, {{{nproc}}} gives you the number of cores. If you're on a dual-core machine, this is equivalent to {{{-j2}}}. 
    4848 
    4949The Fawkes build system distinguishes building the base system and console tools (the {{{all}}} target) and GUI applications (the {{{gui}}} target). This is done for efficiency, especially when working on the robot. The {{{clean}}} target will ensure that the source tree is clean. It is not strictly required on the first run, but if you repeat this step, e.g. after installing more dependencies, this comes handy.