5efea525e0
The root of the documentation tree has a different function to the short readme we want to display on GitHub, which now links to the main docs (or Bay12 thread, or IRC). It also renders properly on GitHub, and can use live-updating status badges because we don't expect it to work offline. |
||
|---|---|---|
| CMake/Modules | ||
| build | ||
| depends | ||
| dfhack-config | ||
| docs | ||
| library | ||
| package | ||
| plugins | ||
| reversing | ||
| scripts | ||
| travis | ||
| .gitignore | ||
| .gitmodules | ||
| .travis.yml | ||
| CMakeLists.txt | ||
| LICENSE.rst | ||
| NEWS.rst | ||
| README.html | ||
| README.md | ||
| dfhack.init-example | ||
| index.rst | ||
README.md
#DFHack Readme
[
]
(https://travis-ci.org/DFHack/dfhack)
[]
(https://dfhack.readthedocs.org)
[
]
(https://en.wikipedia.org/wiki/Zlib_License)
[]
(https://github.com/DFHack/dfhack/issues)
[
]
(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.