X-Git-Url: http://repo.macrolet.net/gitweb/?a=blobdiff_plain;f=README;h=7cc416dfdf558151d46284f65bf4d455501efac8;hb=HEAD;hp=f02c9eccdf67f3b5966aebeebcf618a456d7aef7;hpb=d4b738d6c0b354de817fa490b50814e40872b3d0;p=sbcl.git diff --git a/README b/README index f02c9ec..7cc416d 100644 --- a/README +++ b/README @@ -2,48 +2,34 @@ GENERAL INFORMATION Welcome to SBCL. +If you'd like to install or build the system, see the "INSTALL" file. + To find out more about who created the system, see the "CREDITS" file. If you'd like information about the legalities of copying the system, see the "COPYING" file. -If you'd like to install or build the system, see the "INSTALL" file. - If you'd like more information about using the system, see the man -page, "sbcl.1", or the user manual in the "doc/" subdirectory of the -distribution. (The user manual is maintained as DocBook SGML in the -source distribution; there is an HTML version in the binary -distribution.) +page, "sbcl.1", or the user manual in the "doc/manual" subdirectory of +the distribution. (The user manual is maintained as Texinfo in the +source distribution; HTML version is available for download, and +"INSTALL" describes how to build the Texinfo version in HTML and PDF.) The system is a work in progress. See the "TODO" file in the source distribution for some highlights. +The "BUGS" file lists current known bugs. + If you'd like to make suggestions, report a bug, or help to improve the system, please send mail to one of the mailing lists: sbcl-help@lists.sourceforge.net sbcl-devel@lists.sourceforge.net +Note that as a spam reduction measure you must subscribe to the lists +before you can post. SYSTEM-SPECIFIC HINTS -for OpenBSD: - OpenBSD 3.0 has stricter ulimit values, and/or enforces them more - strictly, than its predecessors. Therefore SBCL's initial mmap() - won't work unless you increase the limit on the data segment from - the OpenBSD defaults, e.g. with - ulimit -S -d 1000000 - before you run SBCL. Otherwise SBCL fails with a message like - "ensure_space: failed to validate xxxxxxx bytes at yyyyy". (SBCL - is just allocating this huge address space, not actually using this - huge memory at this point. OpenBSD <3.0 had no problem with this, - but OpenBSD 3.0 is less hospitable.) - -for Darwin: - PURIFY (which can be used alone but is also used by the system when - saving a new core) uses more stack than the default limit on MacOS - X.2. Therefore, in order to get PURIFY to work reliably, you need - to increase the limit, with e.g. - limit stack 8192 # for the default shell, tcsh - ulimit -s 8192 # for bash - before running SBCL. This is also necessary when building the system - from sources, as part of the build process involves saving a new core. +for NetBSD: + NetBSD 2.0 and above are required because of the lack of needed + signal APIs in NetBSD 1.6 and earlier.