New top-level README file.
[mudpy.git] / README
1 ============= 
2  about mudpy
3 ============= 
4
5 :Copyright: Copyright (c) 2004-2010 Jeremy Stanley <fungi@yuggoth.org>.
6    Permission to use, copy, modify, and distribute this software is granted
7    under terms provided in the LICENSE file distributed with this software.
8
9 The mudpy project aims to create a simple, generic, cross-platform,
10 freely-redistributable MUD core engine which can be easily understood and
11 extended. It is written in pure Python (currently compatible with 2.5 and later
12 2.x versions) and has no prerequisite dependencies beyond Python and its
13 built-in modules. All configuration and data are stored in
14 consistently-formatted plain text files for ease of administration. The core
15 engine is unicode-clean internally and supports UTF-8 encoding for input and
16 output of extended text characters.
17
18 The mudpy program and sample content are released under a free and open
19 license, and any bug reports, criticisms, ideas, patches, content submissions
20 or other offers of collaboration are wholeheartedly welcome. (See our contact
21 page for more information.)