From: Julien Valroff <julien@kirya.net>
Date: Fri, 8 Jan 2010 19:46:22 +0000 (+0100)
Subject: Add basic installation instructions
X-Git-Url: https://gitweb.devoid-pointer.net/?a=commitdiff_plain;h=a1b565d5737623700587f27c634cce8c877a46cd;p=omnibook.git

Add basic installation instructions
---

diff --git a/doc/INSTALL b/doc/INSTALL
new file mode 100644
index 0000000..d9c134d
--- /dev/null
+++ b/doc/INSTALL
@@ -0,0 +1,21 @@
+Basic installation instructions
+==================================
+
+1/ Install GNU make and C compiler (gcc), as well as the configured
+source of the running kernels (ie. either the kernel headers or the
+sources from which you have compiled your own kernel)
+
+2/ get the up-to-date sources:
+$ git://omnibook.git.sourceforge.net/gitroot/omnibook/omnibook
+
+3/ compile, install and load the module against your kernel sources:
+$ cd omnibook/
+# make load
+
+4/ (Optional) Add necessary module options to your /etc/modprobe.conf or in
+a file in /etc/modprobe.d/. e.g.: "options omnibook apmemu=1 dock=1
+user=1"
+
+5/ (Optional) Edit your startup scripts (eg. /etc/rc.local, /etc/rc.modules
+or /etc/modules) to load this module at boot time.
+
diff --git a/doc/README b/doc/README
index e8fb7cd..4260195 100644
--- a/doc/README
+++ b/doc/README
@@ -26,9 +26,6 @@ Supported features depends on the exact laptop model but may include:
 
 Useful links:
 
-Full documentation (HOWTO, Installation instructions, Supported laptops list... ):
-http://omnibook.sourceforge.net/doku.php?id=start
-
 Sourceforge project page:
 http://sourceforge.net/projects/omnibook