Added installation instructions
authorSteven Barth <steven@midlink.org>
Wed, 12 Mar 2008 21:22:07 +0000 (21:22 +0000)
committerSteven Barth <steven@midlink.org>
Wed, 12 Mar 2008 21:22:07 +0000 (21:22 +0000)
INSTALL [new file with mode: 0644]

diff --git a/INSTALL b/INSTALL
new file mode 100644 (file)
index 0000000..5ce58e5
--- /dev/null
+++ b/INSTALL
@@ -0,0 +1,45 @@
+FFLuCI Installation Instructions
+
+TOC:
+1. Kamikaze Packages
+2. Manual Installation
+
+
+
+1. Kamikaze Packages
+       1.      At first make sure you already added "lua" from
+               the OpenWRT Packages repository to your buildroot's "package" directory
+        
+       2.      cd to the "package" directory of your kamikaze buildroot
+       
+       3.      Type: ln -s /path/to/ff-luci/contrib/package/* ./
+       
+       4.      cd to your kamikaze build root and type: make menuconfig
+               You will find ffluci in the menu "Administration"
+
+
+2. Manual Installation
+       Prerequisites:
+               CGI enabled webserver
+               Lua 5.1.x or later
+               LuaFileSystem Lua extension
+               Haserl 0.9x or later with Lua support builtin
+       
+       Installation:
+       Use make to build a distribution of FFLuCI
+               make: creates the source distribution with freifunk config pages
+               make dist-compile: same as above but bytecompiles lua modules
+               
+               make source-examples: creates a plain distribution with example pages
+               make dist-examples: same as above but bytecompiles lua modules
+               
+               make source: creates a plain distribution without pages
+               make compile: same as above but bytecompiles lua modules
+               
+       Put the ffluci dist/ffluci directory somewhere on your harddrive
+       e.g. in your Lua Path
+       
+       Put a bootstrap file like the one in contrib/ffluci into your webservers
+       CGI-Directory and adapt it to your needs.
+       
+       Also have a look at dist/ffluci/config.lua for configuration options.
\ No newline at end of file