changeset 643:f065e3cb846e 1.0.3

Updated documentation
author Sebastien Decugis <sdecugis@nict.go.jp>
date Tue, 21 Dec 2010 10:51:14 +0900
parents 77c7ec18edec
children 718b9c36ce51
files INSTALL INSTALL.Fedora INSTALL.FreeBSD INSTALL.OpenSUSE INSTALL.OpenWRT INSTALL.Ubuntu
diffstat 6 files changed, 36 insertions(+), 32 deletions(-) [+]
line wrap: on
line diff
--- a/INSTALL	Tue Dec 21 10:30:11 2010 +0900
+++ b/INSTALL	Tue Dec 21 10:51:14 2010 +0900
@@ -1,5 +1,15 @@
 This package uses CMake (cmake.org) as building system. You'll need the cmake tool in order 
-to generate the Makefiles for your platform. You can also select which extensions must be built.
+to generate the Makefiles for your platform. You can also select which extensions must be built
+with cmake. After the initial cmake configuration, you will need several tools such as make, a 
+C compiler (tested mostly with gcc), flex, bison, ...
+
+You may retrieve the source package in several ways:
+ - as a pre-packaged version for your platform. Check the website for supported platforms.
+ - as a tarball containing the source.
+ - directly from the repository using Mercurial tool:
+      hg clone http://www.freediameter.net/hg/freeDiameter
+   In order to update later:
+      hg pull -u
 
 Building in a separate directory is recommended:
 # mkdir build
@@ -8,7 +18,7 @@
 # make
 
 You can pass options to instruct cmake about which components to compile on the command-line.
-You can also use a CMake front-end (for example ccmake or cmake-gui) or edit the CCmakeCache.txt file directly. 
+You can also use a CMake front-end (for example ccmake or cmake-gui). 
 If your cmake installation is recent, the edit_cache target is a good help as well:
 # mkdir build
 # cd build
@@ -20,7 +30,10 @@
 You can disable the unit tests by doing:
 # cmake -DBUILD_TESTING:BOOL=OFF ../
 # make
+
+When the tests are not disabled, you can run them with:
 # make tests
 
-Note that there are dependencies on external tools that may not be enforced by the configure script.
-See the specific INSTALL.* files for additional information.
+See the INSTALL.* files for additional platform-specific information.
+Note that the most up-to-date INSTALL file is the Ubuntu one. You may want to read there
+in addition to your own platform file.
--- a/INSTALL.Fedora	Tue Dec 21 10:30:11 2010 +0900
+++ b/INSTALL.Fedora	Tue Dec 21 10:51:14 2010 +0900
@@ -4,15 +4,21 @@
 
 Dependencies on Fedora 13 (from minimal system):
 # yum install cmake make gcc flex bison lksctp-tools-devel gnutls-devel libgcrypt-devel
+
+In addition, if you have not already retrieved the latest source:
 # yum install mercurial
 
 Following dependencies are optional, depending on which extensions you plan to compile
  app_acct:
-	# yum install postgresql-server postgresql-devel
+	# yum install postgresql-devel
+	optional:
+	# yum install postgresql-server
 
  app_sip:
  app_diameap:
-	# yum install mysql-server mysql-devel
+	# yum install mysql-devel
+	optional:
+	# yum install mysql-server 
 	
  dict_legacy_xml:
 	# yum install libxml2 libxml2-devel
@@ -21,21 +27,11 @@
 	# yum install swig python-devel
 
 
-Fetching the latest source:
-# hg clone http://www.freediameter.net/hg/freeDiameter
-# cd freeDiameter
-
-Compiling in a separate directory:
-# mkdir test.build
-# cd test.build
-# cmake ..
-# make
-
 NOTE: You may need to change something in SELinux to allow binding the SCTP socket on Diameter port.
 The following command is the very naive way to do it, you can probably do better (feedback appreciated!)
 # setenforce Permissive
 
 
 There is currently no Fedora-specific package for freeDiameter.
-You are welcome to contribute packaging scripts! Please contact with
-dev@freediameter.net for more details.
+You are welcome to contribute packaging scripts. 
+Please contact dev@freediameter.net for more details.
--- a/INSTALL.FreeBSD	Tue Dec 21 10:30:11 2010 +0900
+++ b/INSTALL.FreeBSD	Tue Dec 21 10:51:14 2010 +0900
@@ -4,7 +4,7 @@
 QUICK INSTRUCTIONS
 ------------------
 
-On FreeBSD-8.0 the following packages were required (should be same on FreeBSD-7.x):
+On FreeBSD-8.0 at least the following ports packages were required (should be same on FreeBSD-7.x):
  cmake flex bison gnutls
 
 Then the cmake command had to look like:
@@ -54,7 +54,7 @@
 9) Install
    # make install
    
-10) Run (the install path can be changed in cmake step):
+10) Run (the install path can be changed during cmake step):
    # /usr/local/bin/freeDiameterd --help
 
 
--- a/INSTALL.OpenSUSE	Tue Dec 21 10:30:11 2010 +0900
+++ b/INSTALL.OpenSUSE	Tue Dec 21 10:51:14 2010 +0900
@@ -22,16 +22,6 @@
 	# zypper install swig python-devel
 
 
-Fetching the latest source:
-# hg clone http://www.freediameter.net/hg/freeDiameter
-# cd freeDiameter
-
-Compiling in a separate directory:
-# mkdir test.build
-# cd test.build
-# cmake ..
-# make
-
 There is currently no OpenSUSE-specific package for freeDiameter.
 You are welcome to contribute packaging scripts! Please contact with
 dev@freediameter.net for more details.
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/INSTALL.OpenWRT	Tue Dec 21 10:51:14 2010 +0900
@@ -0,0 +1,3 @@
+There is a package script available for the OpenWRT platform.
+
+Please refer to contrib/OpenWRT/HOWTO for more information.
--- a/INSTALL.Ubuntu	Tue Dec 21 10:30:11 2010 +0900
+++ b/INSTALL.Ubuntu	Tue Dec 21 10:51:14 2010 +0900
@@ -14,6 +14,7 @@
 As a first step, you have to link this directory from your top-level dir:
   ln -s contrib/debian
  
+============================================
 
 The following packages are required to compile freeDiameter from source:
  cmake make gcc flex bison libsctp1 libsctp-dev libgnutls-dev libgcrypt-dev
@@ -35,8 +36,9 @@
  dbg_interactive:
  	swig python-dev
 	
+============================================
 
-If your debhelper environment is recent (> 7.3.9 to provide cmake support), 
+If your debhelper environment is recent (> 7.3.9 for cmake support), 
 the following commands should generate the freeDiameter packages for you:
 
 # Install the dependencies for building the source:
@@ -69,7 +71,7 @@
 ===========================================
 
 freeDiameter has been tested on the following distributions (compiled from source as described bellow):
-Ubuntu Intrepid, Jaunty, Karmic, Lucid. 
+Ubuntu Intrepid, Jaunty, Karmic, Lucid, Maverick, Natty. 
 Debian Lenny.
 
 Ubuntu Hardy support is known to be broken.
"Welcome to our mercurial repository"