Added Sphinx (reST-style) conversion of Evennia documentation to docs/. This is an auto-generated conversion directly from the Wiki, so it's not custom-written in any way (will also make it easy to update). You need Sphinx to compile the sources into fancy pages. Supporting sphinx is to make documentation easier to print and view offline. Currently no sphinx src-code viewing is activated by default, it gives too many spurious errors (the converters are in the repo though if you're interested in experimenting). So for offline autodocs, doxygen is still to recommend.

This commit is contained in:
Griatch 2011-09-10 23:44:49 +02:00
parent 5a2b9e27a0
commit bd0079a39d
65 changed files with 9394 additions and 143 deletions

View file

@ -0,0 +1,50 @@
Evennia Licence
===============
Evennia is licensed under the very friendly *Modified Clarified Artistic
License*. You can find the license as ``LICENCE`` in the Evennia root
directory. You can also read the full license file
`here <http://code.google.com/p/evennia/source/browse/trunk/LICENSE>`_.
Licence FAQ
-----------
You should read the full license file to know what it says exactly, but
here are some answers to common questions.
Q: I have created a game using Evennia, what does the license allow me
to do with it?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**A:** It's your own world to do with what you please! In summary, a
MU``*`` world you create using Evennia (i.e. the files you create in
``game``) falls under **§6** of the license (it's a sort of "library").
So your game world and all its contents belongs to you (as it should
be). Keep it to yourself or re-distribute it under any license of your
choice - or sell it and become filthy rich for all we care.
Q: I have modified Evennia itself, what does the license say about that?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**A:** The Evennia package itself (i.e. the stuff you download from us)
is referred to as "The Package", "Standard version" in the license.
- If you just fixed a typo or bug, that falls under **§2** - that is,
you don't *have* to do anything to appease the license. Regardless,
we'd of course appreciate it if you submitted bugs/fixes to us so
Evennia becomes more complete!.
- If you made other modifications or added new features to the server,
that's also ok, but falls under **§3** - you must make a clear note
of the changes as well as put the changes into the public domain or
make separate arrangements with us (since it's then no longer a
"Standard version"). Of course, if you plan to add new features to
the server, the easiest way to do so is to simply become an Evennia
developer!
Q: Can I re-distribute Evennia along with my custom game implementation?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**A:** Sure. This is covered in **§4** - just package the "Standard
version" (that is, the one you download from us) with your package. Make
sure to include the original license and disclaimers and note where
users may get it if they want to download it of their own.