Add a demo walk-through to the coder guide

[mudpy.git] / README

diff --git a/README b/README
index e3bb221..8c43f18 100644 (file)
--- a/README
+++ b/README
@@ -1,25 +1,19 @@
-============= 
- about mudpy
-============= 
+=======
+ mudpy
+=======
 
-:Copyright: (c) 2004-2010 Jeremy Stanley <fungi@yuggoth.org>. Permission
-            to use, copy, modify, and distribute this software is
-            granted under terms provided in the LICENSE file distributed
-            with this software.
+.. Copyright (c) 2004-2019 mudpy authors. Permission to use, copy,
+   modify, and distribute this software is granted under terms
+   provided in the LICENSE file distributed with this software.
 
 The mudpy project aims to create a simple, generic, cross-platform,
 freely-redistributable MUD core engine which can be easily understood
-and extended. It is written in pure Python (currently compatible with
-2.5 and later 2.x versions) and has no prerequisite dependencies beyond
-Python and its built-in modules. All configuration and data are stored
-in consistently-formatted plain text files for ease of administration.
-The core engine is unicode-clean internally and supports UTF-8 encoding
-for input and output of extended text characters.
+and extended. It is written in pure Python 3 and has only pure Python
+dependencies. All configuration and data are stored in
+consistently-formatted plain text (YAML 1.1) files for ease of
+administration. The core engine is unicode-clean internally and supports
+UTF-8 encoding for input and output of extended text characters.
 
 The mudpy program and sample content are released under a free and open
 license, and any bug reports, criticisms, ideas, patches, content
 submissions or other offers of collaboration are wholeheartedly welcome.
-
-Please review the other documentation files distributed with this
-software, or visit http://mudpy.org/res/src/mudpy/doc/ for additional
-information.