1.0.18.1: correct handling of SATISFIES types in the compiler
[sbcl.git] / README
diff --git a/README b/README
index 18578d6..86deff3 100644 (file)
--- a/README
+++ b/README
@@ -1,3 +1,5 @@
+GENERAL INFORMATION
+
 Welcome to SBCL.
 
 To find out more about who created the system, see the "CREDITS" file.
@@ -9,14 +11,36 @@ 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.)
+distribution. (The user manual is maintained as Texinfo in the source
+distribution; HTML version is available for download.)
 
 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 NetBSD:
+  NetBSD 2.0 and above are required because of the lack of needed
+  signal APIs in NetBSD 1.6 and earlier.
+
+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.)