Fix documentation for indilib drivers installation.

1 files changed, 31 insertions, 29 deletions

diff --git a/README.indilib-drivers b/README.indilib-drivers
index 494fb30..5983583 100644
--- a/README.indilib-drivers
+++ b/README.indilib-drivers
@@ -1,52 +1,44 @@
-This overlay contains ebuilds for 3rd party drivers included in inidlib.org's releases and code repository.
-
-Refer to the indilib.org to see which hardware is supported by each particular driver.
-
-STEP BY STEP INSTALLATION GUIDE
+INDILIB 3rd PARTY DRIVERS INSTALLATION GUIDE
 
 0. Login as root or use sudo.
 
 1. Install layman to manage overlays if don't have this tool already.
-
 sudo emerge -v app-portage/layman
 
-2. Add brancik-overlay.xml file to the /var/lib/layman/ directory wit the following content:
+2. Add brancik-overlay.xml file to the /etc/layman/overlays directory wit the following content:
 
-sudo nano -w /var/lib/layman/brancik-overlay.xml
+sudo nano -w /etc/layman/overlays/brancik-overlay.xml
 
 <?xml version="1.0" encoding="UTF-8"?>
-<repositories version="1.0">
-<repo priority="50" quality="experimental" status="unofficial">
-    <name>brancik-overlay</name>
-    <description>Some dirty work for my needs.</description>
-    <homepage>http://git.brancik.cz/brancik-overlay</homepage>
-    <owner>
-      <email>ctibor@brancik.cz</email>
-    </owner>
-    <source type="git">git://git.brancik.cz/gentoo-overlay.git</source>
-  </repo>
+<!DOCTYPE repositories SYSTEM "/dtd/repositories.dtd">
+<repositories xmlns="" version="1.0">
+<repo quality="experimental" status="official">
+        <name>brancik-overlay</name>
+        <description>Ctibor Brancik's overlay</description>
+        <homepage>http://git.brancik.cz</homepage>
+        <owner type="project">
+                <email>ctibor@brancik.cz</email>
+                <name>Ctibor Brančík</name>
+        </owner>
+        <source type="git">git://git.brancik.cz/gentoo-overlay.git</source>
+</repo>
 </repositories>
 
 Or you can use layman-overlay-maker tool if you have >=app-portage/layman-2.0.0.
 
-More info about Gentoo overlays and their management can be found on https://wiki.gentoo.org/wiki/Layman.
+More info about Gentoo overlays and their management can be found on http://wiki.gentoo.org/wiki/Layman and in layman man pages.
 
 3. Add overlay:
 
-sudo layman -a overlay
+sudo layman -f -a brancik-overlay
 
-4. To install all available indilib drivers (e.g. for testing if the driver can be compiled on ARCH) simply use provided portage set:
+4. To install all available indilib drivers simply use provided portage set:
 
 sudo emerge -v @indilib-drivers
 
-or if you use ARCH=arm system (e.g. raspberrypi). This set is due to that some drivers use binary code which is compiled for x86 processors only.
-
-sudo emerge -v @indilib-drivers-arm
-
-5. If you want to install only drivers for the devices you use (The Gentoo Way TM), you have to set appropriate USE flags:
+5. If you want to install only drivers for the devices you use (as is the Gentoo way), you have to set appropriate USE flags:
 
 Available USE flags (note that only 3rd party drivers are present, with exception of indi-qhy-old. All other drivers are installed by sci-libs/indilib itself):
-  
   - aagcloudwatcher
   - apogee
   - asicam
@@ -67,13 +59,23 @@ Available USE flags (note that only 3rd party drivers are present, with exceptio
 nano -w /etc/portage/package.use/indilib
 
 #Enable drivers USE flag which pulls sci-libs/indilib-drivers as dependency
+
 sci-libs/indilib drivers
 
 # To install indi_gphoto_ccd, indi_qhy_ccd and indi_sbig_ccd.
 # sci-libs/indilib-drivers is a meta ebuild and works similar to x11-base/xorg-drivers package.
-sci-libs/indilib-drivers gphoto2 qhy sbig
 
+sci-libs/indilib-drivers gphoto2 qhy sbig
 sudo emerge sci-libs/indilib::brancik-overlay
 
+6. Note that ebuilds for stable release of indilib drivers (currently 0.9.9) are keyworded unstable (~amd64, ~x86 specifically) and live source ebuilds are all masked by package.mask. You will have to unmask them during installation (use emerge with --autounmask-write option). See official docs if you do not know this means exactly.
+
+I have tested all the drivers and they compile OK at least on amd64 and arm. Whether they work with your device is up to you to discover :-) I will try to maintain ebuilds as the time goes by and my spare time allows me.
+
+Known problems:
+
+Firmware for sbig (sci-libs/sbig) won't cross emerge if the host machine belongs to different ARCH.
+
+The overlay also includes ebuilds for sci-astronomy/lin_guider, sci-astronomy/ccd, sci-astronomy/qastrocam-g2 and sci-astronomy/open-phd-guiding (version 1 and 2 directly from svn).
 
-6. Note that ebuilds for stable release of indilib drivers (currently 0.9.9) are masked as unstable (~amd64, ~x86 and ~arm specifically) and live source ebuilds are masked by missing keywords. You will have to unmask them during installation (use emerge with --autounmask-write option). See https://wiki.gentoo.org/wiki/Handbook:X86/Portage/Branches if you do not know what to do exactly.
+I hope someone will find this useful and please report any bugs with the ebuilds or compilation failures.
\ No newline at end of file