dfhack fork
 
 
 
 
 
 
Go to file
PeridexisErrant 4fbf9ce233 Clarify LICENSE.rst, deduplicate, add links
A simple list of components with the full text each time is not
particularly useful, or required.

The table lists components in alphabetical order (except DFhack, first),
with license and copyright.  Component names are hyperlinked to the
source project, which was not the case previously.

Licenses which are required to be included are, but once only - an
improvement over four zlib, 3 BSD and five (!) MIT blocks.  This and the
table satisfies the requirements while remaining readable.
2015-11-06 10:15:20 +11:00
CMake/Modules Initial CMake version of Sphinx stuff. 2015-09-24 02:09:23 -04:00
build Bash script to build dfhack according to the instructions in Compile.rst. 2015-01-05 16:02:13 -05:00
depends Travis: Build DFHack 2015-10-03 15:58:41 -04:00
dfhack-config dfstatus: Allow sections and metal bars to be customized 2015-09-03 15:02:08 -04:00
docs Add unacknowledged contributors 2015-11-06 10:15:19 +11:00
library Update xml 2015-11-05 16:17:52 -05:00
package Add hack/libs to DYLD_LIBRARY_PATH on OS X 2015-08-25 14:17:45 -04:00
plugins Update stonesense 2015-11-04 20:06:35 -05:00
reversing Properly handle the variety of exception handlers that MSVC 2010 generates 2012-03-03 14:14:31 -06:00
scripts Document devel scripts 2015-11-06 10:15:18 +11:00
travis Linting: improve script docs check, work off Travis 2015-11-06 10:15:19 +11:00
.gitignore Tweak docs building 2015-10-25 10:14:09 +11:00
.gitmodules Fix .gitmodules. 2015-09-21 20:38:31 -04:00
.travis.yml Fix travis.yml syntax issue 2015-10-30 23:30:06 -04:00
CMakeLists.txt Only search scripts directory with GLOB_RECURSE 2015-11-04 19:54:41 -05:00
LICENSE.rst Clarify LICENSE.rst, deduplicate, add links 2015-11-06 10:15:20 +11:00
NEWS.rst Add pull #717 changes to NEWS 2015-10-31 11:47:13 +11:00
README.html Split GitHub README from Sphinx index 2015-10-28 10:06:28 +11:00
README.md Split GitHub README from Sphinx index 2015-10-28 10:06:28 +11:00
conf.py Linting: improve script docs check, work off Travis 2015-11-06 10:15:19 +11:00
dfhack.init-example Comment out roses-init (shouldn't be run from dfhack.init). 2015-09-26 18:06:24 -04:00
index.rst Split GitHub README from Sphinx index 2015-10-28 10:06:28 +11:00

README.md

#DFHack Readme

[Build Status] (https://travis-ci.org/DFHack/dfhack) [Documentation Status] (https://dfhack.readthedocs.org) [License] (https://en.wikipedia.org/wiki/Zlib_License) [Github Issues] (https://github.com/DFHack/dfhack/issues) [Open Pulls] (https://github.com/DFHack/dfhack/pulls)

DFHack is a Dwarf Fortress memory access library, distributed with scripts and plugins implementing a wide variety of useful functions and tools.

The full documentation is available online here, from the README.html page in the DFHack distribution, or as raw text in the ./docs folder. If you're an end-user, modder, or interested in contributing to DFHack - go read those docs.

If that's unclear or you need more help, try [the Bay12 forums thread] (http://www.bay12forums.com/smf/index.php?topic=139553) or the #dfhack IRC channel on freenode.