Ticket #12898: 12898_readme.patch

File 12898_readme.patch, 8.2 KB (added by Jeroen Demeyer, 10 years ago)
  • README.txt

    # HG changeset patch
    # User Jeroen Demeyer <jdemeyer@cage.ugent.be>
    # Date 1336415541 -7200
    # Node ID 1a4c165574b5bb03bf5855ff93f5d626d59b161e
    # Parent  8e0f8e3ca5605cd4be7acb4fb2385c14785a620b
    Update the README for sage-5.0
    
    diff --git a/README.txt b/README.txt
    a b  
    33       "Creating a Viable Open Source Alternative to
    44          Magma, Maple, Mathematica, and MATLAB"
    55
    6     Copyright (C) 2005-2011 William Stein and the Sage Development Team
     6    Copyright (C) 2005-2012 William Stein and the Sage Development Team
    77
    88        http://www.sagemath.org
    99
     
    1818
    1919GETTING STARTED
    2020---------------
     21
    2122This README.txt contains build instructions for Sage. If you downloaded
    2223a binary, you do not need to do anything; just execute:
    2324
     
    6667
    6768    http://www.sagemath.org/doc/installation
    6869
    69 1. Make sure you have the dependencies and 2.5 GB of free disk space.
     701. Make sure you have the dependencies and 3 GB of free disk space.
    7071
    71    Linux: GCC, g++, gfortran, make, m4, perl, ranlib, and tar.
     72   Linux: gcc, make, m4, perl, ranlib, and tar.
    7273   (install these using your package manager)
     74   On recent Debian or Ubuntu systems (in particular Ubuntu 12.04
     75   "Precise"), you need the dpkg-dev package.
    7376
    74    OS X: Xcode.  Make sure you have installed the most recent version
     77   OS X: Xcode. Make sure you have installed the most recent version
    7578   of Xcode. For pre-Lion versions of OS X, you can download Xcode
    7679   from http://developer.apple.com/downloads/. For OS X Lion, you can
    7780   install it using the App Store. With Xcode 4.3 or later, you need
     
    8386
    84872. Extract the tarball:
    8588
    86        tar -xvf sage-*.tar
     89       tar xvf sage-*.tar
    8790
    88913. cd into the Sage directory and type make:
    8992
     
    9598   want to know!
    9699
    97100
    98 FORTRAN
    99 -------
     101ENVIRONMENT VARIABLES
     102---------------------
    100103
    101 To build Sage on any platform except OS X, you must use a system-wide
    102 gfortran compiler. Sometimes you need to explicitly tell the Sage build
    103 process about the Fortran compiler and library locations. Do this by
    104 typing:
     104There are a lot of environment variables which control the install
     105process of Sage, see:
    105106
    106     export SAGE_FORTRAN=/exact/path/to/gfortran
    107     export SAGE_FORTRAN_LIB=/path/to/fortran/libs/libgfortran.so
    108 
    109 Note that the SAGE_FORTRAN environment variable is supposed to impact
    110 *only* the Fortran Sage package, otherwise known as the Fortran spkg
    111 ("spkg" stands for "Sage package").  Apart from that, this variable is
    112 *not* designed to do anything at all to other spkg's that use
    113 Fortran. For example, the Lapack spkg uses Fortran, but the
    114 compilation process of Lapack should ignore the SAGE_FORTRAN
    115 environment variable. The SAGE_FORTRAN environment variable does not
    116 mean "build any spkg that uses Fortran using this Fortran". It means
    117 "when installing the Fortran spkg, setup the sage_fortran script to
    118 run the Fortran specified by the SAGE_FORTRAN variable".
     107    http://sagemath.org/doc/installation/source.html#environment-variables
    119108
    120109
    121110SELINUX
     
    123112
    124113On Linux, if you get this error message:
    125114
    126     " restore segment prot after reloc: Permission denied "
     115    Error: cannot restore segment prot after reloc: Permission denied
    127116
    128117the problem is probably related to SELinux. See the following URL for
    129118further information:
    130119
    131     http://www.ittvis.com/services/techtip.asp?ttid=3092
     120    http://www.exelisvis.com/Support/HelpArticleDetail/ArticleId/3092.aspx
    132121
    133122
    134123IMPLEMENTATION
     
    143132MORE DETAILED INSTRUCTIONS TO BUILD FROM SOURCE
    144133-----------------------------------------------
    145134
    146 1. Make sure you have about 2.5 GB of free disk space.
     1351. Make sure you have about 3 GB of free disk space.
    147136
    1481372. Install build dependencies.
    149138
     
    195184       export SAGE_CHECK="yes"
    196185
    197186   before starting the Sage build. This will run each test suite and
    198    will raise an error if any failures occur.  Warning: on many
    199    platforms, this will cause failures in the installation of the
    200    Python spkg, so Python's test suite has been disabled by default.
    201    To renable it, set the environment variable SAGE_CHECK_PACKAGES to
    202    'python'.
    203    
     187   will raise an error if any failures occur. Python's test suite has
     188   been disabled by default, because it causes failures on most
     189   systems. To renable the Python testsuite, set the environment
     190   variable SAGE_CHECK_PACKAGES to "python".
     191
    204192   To start the build, type:
    205193
    206194       make
    207195
    208 
    2091964. Wait about 1 hour to 14 days, depending on your computer (it took
    210197   about 2 weeks to build Sage on the T-Mobile G1 Android cell phone).
    211198
     
    227214
    2282158. OPTIONAL: If you want to (try to) build the documentation, run:
    229216
    230        sage -docbuild --help
     217       sage --docbuild --help
    231218
    232219   for instructions. The HTML version of the documentation is built
    233220   during the compilation process of Sage and resides in the directory:
     
    2392269. OPTIONAL: It is highly recommended that you install the optional GAP
    240227   database by typing:
    241228
    242        ./sage -optional
     229       ./sage --optional
    243230
    244231   then installing (with "./sage -i") the package whose name begins with
    245232   database_gap. This will download the package from
     
    262249process will stop soon after, so check the most recent log files
    263250first, or run
    264251
    265    grep -li "An error" spkg/logs/*
     252   grep -li "^Error" spkg/logs/*
    266253
    267254from the top-level Sage directory to find log files with error
    268255messages in them.  Send (a small part of) the relevant log file to the
     
    274261SUPPORTED COMPILERS
    275262-------------------
    276263
    277  * Sage needs a version of GCC that is at least version 4.0.1 that is
    278    configured with support for at least the C, C++, and Fortran
    279    languages, although a Fortran compiler is not needed on OS X, as
    280    noted above.
     264Sage includes a GCC (GNU Compiler Collection) package. In order to
     265build Sage, you need a C compiler which can build GCC and its
     266prerequisites. gcc version 4.0.1 or later should probably work. On
     267Solaris or OpenSolaris, building with the Sun compiler should also work.
    281268
    282  * The versions of the C compiler (gcc), C++ compiler (g++), and Fortran
    283    compiler (gfortran) must all be identical.
     269The GCC package in Sage is not always installed. It is determined
     270automatically whether it needs to be installed. You can override this
     271by setting the environment variable SAGE_INSTALL_GCC=yes (to force
     272installation of GCC) or SAGE_INSTALL_GCC=no (to disable installation of
     273GCC). If you don't want to install GCC, you need to have recent
     274versions of gcc, g++ and gfortran; moreover, the versions must be equal.
    284275
    285  * Sage has never been built without using the GCC compiler.
     276There are some known problems with old assemblers, in particular when
     277building the ECM package. You should ensure that your assembler
     278understands all instructions for your processor. On Linux, this means
     279you need a recent version of binutils; on OS X you need a recent version
     280of XCode.
    286281
    287282
    288283RELOCATION
     
    316311
    3173121. To make your own source tarball (sage-x.y.z.tar) of Sage, type:
    318313
    319        sage -sdist x.y.z
     314       sage --sdist x.y.z
    320315
    321316   where the version is whatever you want.
    322317
    3233182. To make a binary distribution with your currently installed packages,
    324319   type:
    325320
    326        sage -bdist x.y.z
     321       sage --bdist x.y.z
    327322
    3283233. To make a binary that will run on the widest range of target
    329324   machines, set the SAGE_FAT_BINARY environment variable to "yes"
     
    331326
    332327       export SAGE_FAT_BINARY="yes"
    333328       make
    334        ./sage -bdist x.y.z-fat
     329       ./sage --bdist x.y.z-fat
    335330
    336331In all cases, the result is placed in the directory "$SAGE_ROOT/dist/".
    337332
     
    343338and released under an open source license that is "GPL version 3 or
    344339later" compatible. See the file COPYING.txt for more details.
    345340
    346 Each spkg in $SAGE_ROOT/spkg/standard/ is a bzip'd tarball. You can
    347 extract it with:
     341Almost every spkg in $SAGE_ROOT/spkg/standard/ is a bzip2-compressed
     342tarball (currently, the only exception is the bzip2 spkg itself, which
     343is gzip-compressed). You can extract it with:
    348344
    349     tar -jxvf name-*.spkg
     345    tar xvf name-*.spkg
    350346
    351347Inside the spkg, there is a file SPKG.txt that details all changes made
    352348to the given package for inclusion with Sage. The inclusion of such a