Changeset 643:f065e3cb846e in freeDiameter

Timestamp:

Dec 21, 2010, 10:51:14 AM (13 years ago)

Author:

Sebastien Decugis <sdecugis@nict.go.jp>

Branch:

default

Phase:

public

Tags:

1.0.3

Message:

Updated documentation

Files:

• INSTALL (modified) (3 diffs)
• INSTALL.Fedora (modified) (3 diffs)
• INSTALL.FreeBSD (modified) (2 diffs)
• INSTALL.OpenSUSE (modified) (1 diff)
• INSTALL.OpenWRT (added)
• INSTALL.Ubuntu (modified) (3 diffs)

INSTALL

@@ -1 +1 @@
 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:
@@ -9 +19 @@
 
 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
@@ -21 +31 @@
 # 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.

INSTALL.Fedora

@@ -5 +5 @@
 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:
@@ -22 +28 @@
 
 
-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!)
@@ -38 +34 @@
 
 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.

INSTALL.FreeBSD

@@ -5 +5 @@
 ------------------
 
-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
 
@@ -55 +55 @@
    # 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
 

INSTALL.OpenSUSE

@@ -23 +23 @@
 
 
-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

INSTALL.Ubuntu

@@ -15 +15 @@
   ln -s contrib/debian
  
+============================================
 
 The following packages are required to compile freeDiameter from source:
@@ -36 +37 @@
         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:
 
@@ -70 +72 @@
 
 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.