From d954384df1d9818ae886fc23fe20b3f310e78419 Mon Sep 17 00:00:00 2001 From: kanschat Date: Mon, 15 Aug 2011 22:33:44 +0000 Subject: [PATCH] clarify configuration an making git-svn-id: https://svn.dealii.org/trunk@24079 0785d39b-7218-0410-832d-ea1e28bc413d --- deal.II/doc/readme.html | 62 ++++++++++++++++++++++++----------------- 1 file changed, 37 insertions(+), 25 deletions(-) diff --git a/deal.II/doc/readme.html b/deal.II/doc/readme.html index eb2402eb14..33576e059a 100644 --- a/deal.II/doc/readme.html +++ b/deal.II/doc/readme.html @@ -205,38 +205,50 @@

Installation

-

+

Unpacking

The whole library usually comes as a .tar.gz file, that is a - tarred file archive which is compressed with gzip. After unpacking - it with gunzip and tar (or tar xzf if you use GNU tar), you will - find several subdirectories. First run the script -

-         ./configure
-    
- in the top-level directory, - which sets some paths and finds out what compiler you - use. ./configure supports several flags which are discussed + tarred file archive which is compressed with gzip. After downloading this + tar file, please unpack it at the position where you want to install the + deal.II library using either +
+      gunzip deal.II-X.Y.Z.tar.gz
+      tar xf deal.II-X.Y.Z.tar
+    
+ or, if you have GNU tar with +
+      tar xzf deal.II-X.Y.Z.tar.gz
+    
+ Unpacking will create a subdirectory deal.II with + the whole library wherever you do it). + +

Configuration

+ Unpacking will create a subdirectory deal.II. First run +
+      cd deal.II
+      ./configure
+    
+ to set some paths and find out your system parameters. configure + supports several flags which are discussed further down below.

- The most important result of ./configure is the - creation of the files common/Make.global_options and - include/deal.II/base/config.h. The first - file contains compiler options, paths, etc which you may want to - use in the Makefiles - of your own projects. More - information about Makefiles can also be found in the section on - development. - The second generated file contains preprocessor - definitions that can be used to conditionalize pieces of the source code. + ./configure creates the + file deal.II/common/Make.global_options, + which remembers paths and configuration options. Please note that it is not + possible to move the library directory after configuration. Neither will + the library compile, nor will your application programs be able to use it. + You can + use deal.II/common/Make.global_options in the + Makefiles + of your own projects to set relevant paths and parameters correctly.

-

- After configuring, type `make', to obtain the following help (this +

Building the library

+ After configuring, type make, to obtain the following help (this output may change slightly over time, just try it): -

+    
     ========================================================================
     =              Global Makefile for the deal.II libraries               =
     ========================================================================
@@ -255,7 +267,7 @@
     =    clean      : removes all object files in subdirs                  =
     =    distclean  : removes all object files, libraries, etc in subdirs  =
     ========================================================================
-    
+

To execute one of the commands, type for example make @@ -311,7 +323,7 @@

- Apart from the libraries, you should generate the full set of + Apart from the libraries, you can generate the full set of documentation files, by typing make online-doc; this takes some minutes but you will have (almost) all the documentation locally on your computer. You -- 2.39.5