Split readme into files for scripts, plugins, and base

The plugin docs are still a mess, but the base and scripts are now close
to manageable.
develop
PeridexisErrant 2015-09-22 23:30:22 +10:00
parent eb5286dd86
commit 8141de869b
5 changed files with 3488 additions and 3485 deletions

@ -1,12 +1,43 @@
Welcome to DFHack's documentation!
==================================
Introduction
============
DFHack is a Dwarf Fortress memory access library, distributed with scripts
and plugins implementing a wide variety of useful functions and tools.
For users, it provides a significant suite of bugfixes and interface
enhancements by default, and more can be enabled. There are also many tools
(such as ``workflow`` or ``autodump``) which can make life easier. You can
even add third-party scripts and plugins to do almost anything!
For modders, DFHack makes many things possible. Custom reactions, new
interactions, magic creature abilities, and more can be set through scripts
and custom raws. Non-standard DFHack scripts and inits can be stored in the
raw directory, making raws or saves fully self-contained for distribution -
or for coexistence in a single DF install, even with incompatible components.
For developers, DFHack unites the various ways tools access DF memory and
allows easier development of new tools. As an open-source project under
various copyleft licences, contributions are welcome.
Documentation
=============
DFHack documentation is generated by Sphinx. Check out the table of contents
below, or the sources in the docs folder!
TODO: make this work on Github!
Contents for users:
.. toctree::
:maxdepth: 2
docs/Readme
docs/Plugins
docs/Scripts
Contents for developers:

@ -1,8 +1,9 @@
Contributors
============
If you belong here and are missing, please add yourself and send me (peterix) a pull request :-)
List of Authors
===============
The following is a list of people who have contributed to **DFHack**, in no
particular order.
The following is a list of people who have contributed to **DFHack**.
If you should be here and aren't, please get in touch or make a pull request!
======================= ==================== ===========================
Name Github Email
@ -82,22 +83,7 @@ Wes Malone wesQ3
Michon van Dooren MaienM
Seth Woodworth sethwoodworth
Vjek
======================= ==================== ===========================
And these are the cool people who made **Stonesense**.
======================= ==================== ===========================
Name Github Email
======================= ==================== ===========================
Kris Parker kaypy
Japa JapaMala japa.mala.illo@gmail.com
Jonas Ask jonask84@gmail.com
Petr Mrázek peterix peterix@gmail.com>
Caldfir caldfir aitken.tim@gmail.com
8Z 8Z git8z@ya.ru
Alexander Gavrilov angavrilov angavrilov@gmail.com
Timothy Collett danaris tcollett+github@topazgryphon.org
Lethosor lethosor
Eswald eswald
PeridexisErrant PeridexisErrant PeridexisErrant@gmail.com
======================= ==================== ===========================

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff