update RELEASE_NOTES
authorCraig Dowell <craigdo@ee.washington.edu>
Mon, 30 Jun 2008 14:17:19 -0700
changeset 3361 b8db6cd10444
parent 3360 882d82aae6c2
child 3362 9a6f1b3c6e0b
update RELEASE_NOTES
RELEASE_NOTES
--- a/RELEASE_NOTES	Mon Jun 30 13:47:05 2008 -0700
+++ b/RELEASE_NOTES	Mon Jun 30 14:17:19 2008 -0700
@@ -5,21 +5,68 @@
 
 Release 3.1 (2008/06/30)
 ========================
-First supported ns-3 release.
+
+The first ns-3 stable release
+-----------------------------
+
+This release is immediately available from:
+http://www.nsnam.org/releases/ns-3.1.tar.bz2
+
+We dedicate this initial ns-3 release to our late contributor and friend, 
+Federico Maguolo.
+
+What is ns-3 ?
+--------------
+
+ns-3 is a new discrete-event network simulator designed for supporting network
+research and education. ns-3 features a solid, well documented C++ core and 
+models for TCP/IP (IPv4), several link types including WiFi, and mobility 
+models.
+
+ns-3 is an open source project released under the GNU GPLv2 license which 
+allows anyone to use ns-3 without having to pay any license fee or royalties. 
+ns-3 is actively seeking new contributors to extend the range of supported 
+models and/or to maintain existing models.
+
+Where to get more information about ns-3
+----------------------------------------
+
+All the ns-3 documentation, is accessible from the ns-3 website: 
+http://www.nsnam.org
 
-- TCP bugfixes and support for packet tags
-- CSMA NetDevice cleanup and documentation
-- internet-node renamed to internet-stack
-- Socket::RecvFrom added; "flags" argument added to Send calls
-- updated doxygen
-- several bugs and open issues closed out
-- revised tutorial
+Including, tutorials:
+http://www.nsnam.org/tutorials.html
+
+Supported platforms
+-------------------
+
+ns-3 is regularly tested on the following platforms:
+  - linux x86 gcc 4.2, 4.1, and, 3.4.6.
+  - linux x86_64 gcc 4.1.3, 4.2.1, 3.4.6
+  - MacOS X ppc and x86
+  - cygwin gcc 3.4.4 (debug only)
+
+Known issues
+------------
 
-Note:  Some API in class ns3::Ipv4 and ns3::Ipv4RoutingProtocol is 
-deprecated and may be removed and replaced in future releases.
+ns-3 is known to fail on the following platforms:
+  - gcc 3.3 and earlier
+  - optimized builds on gcc 3.4.4 and 3.4.5
+  - optimized builds on linux x86 gcc 4.0.x
+
+The IPv4 API defined in src/node/ipv4.h is expected to undergo major changes 
+in preparation of the merge of the IPv6 API and implementation.
+
+Future releases
+---------------
+
+Our next release, which is expected to happen in 2 to 4 months from now, will
+feature the merging of some of our projects currently in development: python 
+scripting, IPv6, emulation, a statistics framework and synchronous posix 
+sockets.
 
 Release 3.0.13 (2008/06/02)
-========================
+===========================
 - point to point links generate ppp pcap traces
 - point to point links support asymmetrical data rates.
 - generate doxygen documentation for all attributes and trace sources
@@ -39,7 +86,7 @@
 absolute.
 
 Release 3.0.12 (2008/04/07)
-========================
+===========================
     - Add Attribute support to the TypeId metadata system and add
 attribute support to all in-tree models
     - Add a mid-level helper API to build simulation topologies 
@@ -52,7 +99,7 @@
     - TCP delayed acknowledgements and multitasking server
 
 Release 3.0.11 (2008/02/15)
-========================
+===========================
     - Initial port of GTNetS TCP implementation (initial version 
 that does not support multitasking or delayed acknowledgments yet, 
 but supports a reliable stream service)
@@ -62,13 +109,13 @@
     - tutorial updates
 
 Release 3.0.10 (2008/01/15)
-========================
+===========================
    - Add tutorial document content;
    - Valgrind option for "waf" tool;
    - Doxygen organization changes.
 
 Release 3.0.9 (2007/12/15)
-========================
+==========================
    - A 802.11 model ported from Yans. This model supports:
        * a rather extensive PHY model
        * log-distance and friis propagation model
@@ -82,26 +129,26 @@
    - many bugs fixed
 
 Release 3.0.8 (2007/11/15)
-========================
+==========================
    - A simple error model
    - Source files for ns-3 tutorial
 
 Release 3.0.7 (2007/10/15)
-========================
+==========================
   - OLSR routing protocol
   - A timer class
   - Additional mobility models (random waypoint, random 2D walk)
   - A mobility visualization tool 
 
 Release 3.0.6 (2007/09/15)
-========================
+==========================
   - Static multicast IPv4 routing
   - Logging overhaul (NS_LOG macros)
   - Refactoring of tracing subsystem
   - Tutorial document started
  
 Release 3.0.5 (2007/08/15)
-========================
+==========================
 
   - Refactoring to support win32-based unix environments (Cygwin, mingw)
   - "Packet socket" for allowing applications to access NetDevices directly
@@ -112,7 +159,7 @@
   - Global unicast centralized routing 
 
 Release 3.0.4 (2007/07/15)
-========================
+==========================
 
   - Enable waf as the default build system.
   - Per-packet metadata:  a system to track which headers and trailers 
@@ -120,7 +167,7 @@
   - Simplifications to point-to-point devices and channel
 
 Release 3.0.3 (2007/06/15)
-========================
+==========================
 
   - Enable Waf for release tarballs: users can now build ns-3
     with the "waf" tool. See doc/build-waf.txt.
@@ -133,7 +180,7 @@
   - Many small API cleanups
 
 Release 3.0.2 (2007/05/18)
-========================
+==========================
 
   - Implement a new memory management infrastructure based
     on reference counting and smart pointers (the latter being
@@ -145,7 +192,7 @@
   - Add support for a BSD-style socket API for user applications
 
 Release 3.0.1 (2007/03/31)
-========================
+==========================
 
   - First public release; not yet pre-alpha.