Changeset 643:f065e3cb846e in freeDiameter for INSTALL

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

File:

• INSTALL (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.