MetzNet
/
dfhack
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
dfhack/README.rst

60 lines
1.6 KiB
ReStructuredText
Raw Normal View History Unescape Escape

Standard basic sphinx setup
2015-09-22 01:42:15 -06:00
Welcome to DFHack's documentation!
==================================
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.
2015-09-22 07:30:22 -06:00
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
More consistent formatting Eg use of monospaced font, line length, internal links, added xml SYNTAX to root table of contents.
2015-09-24 04:17:58 -06:00
(such as `plugins/workflow` or `plugins/autodump`) which can make life easier.
You can even add third-party scripts and plugins to do almost anything!
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.
2015-09-22 07:30:22 -06:00
For modders, DFHack makes many things possible. Custom reactions, new
More internal links and consistent formatting Links everywhere, and formatting throughout Plugins.rst
2015-09-24 22:15:05 -06:00
interactions, magic creature abilities, and more can be set through `scripts <scripts/modtools>`
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.
2015-09-22 07:30:22 -06:00
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
Format LICENSE - minimal content changes No changes whatsoever are made to the licenses. Formatting is consistent. Comments are cleaned up a little. Some quotation marks are consistent. Added link target and links.
2015-09-24 04:19:51 -06:00
`various copyleft licences <license>`, contributions are welcome.
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.
2015-09-22 07:30:22 -06:00
Documentation
=============
DFHack documentation is generated by Sphinx. Check out the table of contents
More internal links and consistent formatting Links everywhere, and formatting throughout Plugins.rst
2015-09-24 22:15:05 -06:00
below, or the sources in the `docs folder`_!
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.
2015-09-22 07:30:22 -06:00
More internal links and consistent formatting Links everywhere, and formatting throughout Plugins.rst
2015-09-24 22:15:05 -06:00
.. _`docs folder`: ./docs
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.
2015-09-22 07:30:22 -06:00
Include changelog and licenses in generated docs We may want to use .rst formatting for these eventually, and maybe move the NEWS file to docs/News.rst and docs/History.rst - but for now including the raw text works well enough.
2015-09-22 19:03:26 -06:00
User Manual:
Standard basic sphinx setup
2015-09-22 01:42:15 -06:00
.. toctree::
:maxdepth: 2
Only have one file named Readme
2015-09-24 20:09:57 -06:00
docs/Core
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.
2015-09-22 07:30:22 -06:00
docs/Plugins
docs/Scripts
Misc changes for better structure
2015-09-22 02:42:15 -06:00
Include changelog and licenses in generated docs We may want to use .rst formatting for these eventually, and maybe move the NEWS file to docs/News.rst and docs/History.rst - but for now including the raw text works well enough.
2015-09-22 19:03:26 -06:00
Other Contents:
.. toctree::
:maxdepth: 1
docs/Authors
docs/Licenses
docs/Changelog
For Developers:
Misc changes for better structure
2015-09-22 02:42:15 -06:00
.. toctree::
:maxdepth: 1
Moved documentation to docs directory
2015-09-22 02:15:07 -06:00
docs/Contributing
docs/Compile
docs/Lua API
More consistent formatting Eg use of monospaced font, line length, internal links, added xml SYNTAX to root table of contents.
2015-09-24 04:17:58 -06:00
library/xml/SYNTAX
Consolidate binpatch docs. Closes #546 Binpatches aren't used much at the moment, so this has two purposes: collate information so it's easier to write them again, and remove it from other sections where it's useless. Note that if the standalone binpatch.exe is removed, the 'patching on disk' section can be cleanly removed from 'Using a patch' by deleting lines 44-47 & 61-90.
2015-09-25 07:33:28 -06:00
docs/Binpatches