update credits
[librepilot.git] / package / linux / gentoo / README
blobb724793b56b1346f29e7cbc3753d2b5ffd6231c7
1 Installing Librepilot under Gentoo Linux
2 ========================================
4 Introduction
5 ------------
6 The codebase for LibrePilot compiles under linux, windows and
7 iOS. There are a number of libraries and tools which install to enable
8 the compilation environment to be consistent for the different
9 developers working on different platforms. The ebuilds created for
10 Gentoo installation use the system installed libraries, and do not
11 install the packages, except for the arm compiler. Getting a
12 system wide arm compiler working was considered to be more difficult
13 than just downloading the arm package and installing it in the build
14 environment. The implication of this decision is that the arm compiler
15 will download and install every time you install LibrePilot.
17 The installation has been checked on one system. It is possible a
18 dependency has been missed from the ebuild - if you find any issues
19 with building or running, please let me know.
21 Preparation for Installation
22 ----------------------------
23 You need to install and set up layman
24 (https://wiki.gentoo.org/wiki/Layman), then add the librepilot overlay:
26 > layman -a librepilot
28 You can now proceed with installing the latest stable release or the
29 "next" development branch.
31 Installation
32 ------------
34 If you have previously installed LibrePilot by running "make install"
35 as root, you will need to run "make uninstall" first to remove all the
36 files which have been installed. Check everything has been removed by
37 removing the following directories
38    /usr/local/share/librepilot-gcs
39    /usr/local/lib64/librepilot-gcs
41 Also confirm that /usr/local/lib is a symbolic pointer to
42 /usr/local/lib64. This changed recently with the baselayout update to
43 2.4.1-r2, and in fact if you have librepilot installed when making
44 this update it will fail. If you have issues with baselayout updates,
45 unmerge librepilot while updating baselayout.
47 You can choose to install the latest release, or the next branch from
48 the git repository. Instructions for both follow.
50 Installing the latest Release
51 -----------------------------
52 Now you can install Librepilot:
54 > emerge -av librepilot
56 I have marked the ebuilds as unstable ("~"), as they haven't been extensively
57 tested on different computers. Therefore, you will be presented with
58 the option to add some changes to use flags:
60 -------------8<---------------
61     The following keyword changes are necessary to proceed:
62      (see "package.accept_keywords" in the portage(5) man page for more details)
63     # required by librepilot (argument)
64     =app-misc/librepilot-16.09 ~amd64
66     Would you like to add these changes to your config files? [Yes/No]
67 -------------8<---------------
69 Accept the changes, then run dispatch-conf to incorporate them, before
70 running the emerge command again.
72 The package should now proceed to build and install.
74 Installing the latest development branch
75 ----------------------------------------
77 For the latest "next" branch from the repository, you need to install
78 using the following command:
80 > emerge -av =app-misc/librepilot-9999
82 Again, you will be offered some changes to the use flags:
84 -------------8<---------------
85     The following keyword changes are necessary to proceed:
86      (see "package.accept_keywords" in the portage(5) man page for more details)
87     # required by =app-misc/librepilot-9999 (argument)
88     =app-misc/librepilot-9999 **
90     NOTE: The --autounmask-keep-masks option will prevent emerge
91           from creating package.unmask or ** keyword changes.
92 -----------8<------------------
94 Depending on your settings, you may have to add the changes manually
95 to your configuration files.
97 Then run the emerge command again, and it should install.
100 Running GCS
101 -----------
102 Part of the build process includes adding an environment variable for
103 the google maps version. If you run the librepilot-gcs before logging
104 out and back in, you will have issues with the maps in the flight
105 tab. Alternatively, run the following command from a user shell:
107 > . /etc/profile
110 Problems?
111 ---------
112 Please contact paulj@librepilot.org, and I will try my best to sort
113 you out!
115 13/10/2017