OSDN Git Service

remove task for packaging
[jnethack/source.git] / README
diff --git a/README b/README
index 8013ec6..3b4ebac 100644 (file)
--- a/README
+++ b/README
@@ -1,25 +1,29 @@
-                NetHack 3.6.0 -- General information
-
-NetHack 3.6 is an enhancement to the dungeon exploration game NetHack.
-It is a distant descendent of Rogue and Hack, and a direct descendent of
-NetHack 3.4. In order to avoid confusion with interim development code 
-that was posted online in 2014 by others, there is no NetHack 3.5 release.
-
-NetHack 3.6.0 contains some code reorganization, new features, and bugfixes.
-
-The file doc/fixes36.0 in the source distribution has a full list of each. 
-The text in there was written for the development team's own use and is 
-provided "as is", so please do not ask us to further explain the entries 
-in that file. Some entries might be considered "spoilers", particularly
-in the "new features" section.
-
-Here are some additional general notes that are not considered spoilers:
- * Some code paths and long-established game features have been made 
-   part of the base build and no longer conditional on compile settings.
- * Several treasured NetHack community patches, or a variation of 
-   them, have been rolled in to the base NetHack source tree, incuding: 
-   menucolors, pickup thrown, statue glyphs, dungeon overview, sortloot.
-
+         NetHack 3.6.6 -- General information March 2020
+
+NetHack 3.6 is an enhancement to the dungeon exploration game NetHack,
+which is a distant descendent of Rogue and Hack, and a direct descendent of
+NetHack 3.4 as there was no NetHack 3.5 release.
+
+NetHack 3.6.6 is the official release of NetHack that follows NetHack 3.6.5
+and contains bug fixes since 3.6.5, including a security fix that affected
+versions 3.6.1, 3.6.2, 3.6.3, 3.6.4 and 3.6.5.
+
+The file doc/fixes36.6 in the source distribution has a full list of fixes.
+The text in there was written for the development team's own use and is
+provided "as is", so please do not ask us to further explain the entries in
+that file.  Some entries might be considered "spoilers", particularly in the
+"new features" section.
+
+Below you will find some other general notes that were not considered
+spoilers:
+
+ *  invalid status highlight color could be maliciously used to corrupt memory
+ *  formatting corpse names used internal buffers differently from formatting
+ *      other objects and could potentially clobber memory
+ *  avoid divide by 0 crash if 'bogusmon' (file of bogus monster types) is empty
+ *  avoid #wizrumorcheck crash if either 'rumors.tru' or 'rumors.fal' or both
+ *      were empty when makedefs built 'rumors'
                         - - - - - - - - - - -
 
 Please read items (1), (2) and (3) BEFORE doing anything with your new code.
@@ -29,13 +33,13 @@ Please read items (1), (2) and (3) BEFORE doing anything with your new code.
     call it.
 
 2.  Having unpacked, you should have a file called 'Files' in your Top
-    directory.  
+    directory.
 
     This file contains the list of all the files you now SHOULD
     have in each directory.  Please check the files in each directory
     against this list to make sure that you have a complete set.
 
-    This file also contains a list of what files are created during 
+    This file also contains a list of what files are created during
     the build process.
 
     The names of the directories listed should not be changed unless you
@@ -60,14 +64,17 @@ Please read items (1), (2) and (3) BEFORE doing anything with your new code.
     At the time of this release, NetHack 3.6 has been tested to run/compile
     on:
 
-        Intel Pentium or better (or clone) running Linux, BSDI, or 
+        Intel Pentium or better (or clone) running Linux, BSDI, or
                 Windows (7 through 10)
         Intel 80386 or greater (or clone) boxes running Linux, or BSDI
-       Mac OS X 10.9
-       OpenVMS (aka VMS) V8.4 on Alpha and on Integrity/Itanium/IA64
+        Mac OS X 10.11 (follow the instructions in sys/unix, not sys/mac)
+        OpenVMS (aka VMS) V8.4 on Alpha and on Integrity/Itanium/IA64
+
+    Instructions have been provided by way of community contribution on:
+        msdos protected mode using djgpp
 
-    Previous versions of NetHack were tested and known to run on the 
-    following systems, but it is unknown if they can still build and 
+    Previous versions of NetHack were tested and known to run on the
+    following systems, but it is unknown if they can still build and
     execute NetHack 3.6:
 
         Apple Macintosh running MacOS 7.5 or higher, LinuxPPC, BeOS 4.0
@@ -98,7 +105,7 @@ Please read items (1), (2) and (3) BEFORE doing anything with your new code.
         Intel x86 running a version of Windows prior to XP.
         Mips M2000 running RiscOS 4.1
         NeXT running Mach (using BSD configuration)
-       Palm Size PC 1.1 devices running Windows CE 2.11
+        Palm Size PC 1.1 devices running Windows CE 2.11
         Pocket PC devices running Windows CE 3.0 and higher
         Pyramid 9820x running OSx 4.4c
         SGI Iris running IRIX
@@ -120,22 +127,26 @@ Please read items (1), (2) and (3) BEFORE doing anything with your new code.
 
                         - - - - - - - - - - -
 
-If you have problems building the game, or you find bugs in it, we recommend 
+If you have problems building the game, or you find bugs in it, we recommend
 filing a bug report from our "Contact Us" web page at:
-    http://www.nethack.org/ 
+    https://www.nethack.org/common/contact.html
+Please include the version information from #version or the command line
+option --version in the appropriate field.
 
 A public repository of the latest NetHack code that we've made
 available can be obtained via git here:
-    <FIXME>
+    https://github.com/NetHack/NetHack
+      or
+    https://sourceforge.net/p/nethack/NetHack/
 
 When sending correspondence, please observe the following:
 o Please be sure to include your machine type, OS, and patchlevel.
-o Please avoid sending us binary files (e.g. save files or bones files). 
+o Please avoid sending us binary files (e.g. save files or bones files).
   If you have found a bug and think that your save file would aid in solving
-  the problem, send us a description in words of the problem, your machine 
-  type, your operating system, and the version of NetHack.  Tell us that you 
+  the problem, send us a description in words of the problem, your machine
+  type, your operating system, and the version of NetHack.  Tell us that you
   have a save file, but do not actually send it.
-  You may then be contacted by a member of the development team with the 
+  You may then be contacted by a member of the development team with the
   address of a specific person to send the save file to.
 o Though we make an effort to reply to each bug report, it may take some
   time before you receive feedback.  This is especially true during the
@@ -144,17 +155,21 @@ o We don't give hints for playing the game.
 o Don't bother to ask when the next version will be out or you can expect
   to receive a stock answer.
 
-If you want to submit a patch for the NetHack source code via email directly, 
+If you want to submit a patch for the NetHack source code via email directly,
 you can direct it to this address:
     nethack-bugs (at) nethack.org
 
-If a feature is not accepted you are free, of course, to post the patches 
+If a feature is not accepted you are free, of course, to post the patches
 to the net yourself and let the marketplace decide their worth.
 
 All of this amounts to the following:  If you decide to apply a free-lanced
 patch to your 3.6 code, you are welcome to do so, of course, but we won't
-be able to provide support or receive bug reports for it.  
+be able to provide support or receive bug reports for it.
 
 In our own patches, we will assume that your code is synchronized with ours.
 
                   -- Good luck, and happy Hacking --
+
+# $NHDT-Date: 1583508658 2020/03/06 15:30:58 $ $NHDT-Branch: NetHack-3.6-Mar2020 $:$NHDT-Revision: 1.80 $
+# Copyright (c) 2012 by Michael Allison
+# NetHack may be freely redistributed.  See license for details.