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