diff --git a/docs/Compile.rst b/docs/Compile.rst index 26f720076..68187e7fa 100644 --- a/docs/Compile.rst +++ b/docs/Compile.rst @@ -1,3 +1,5 @@ +.. _compile: + ################ Compiling DFHack ################ diff --git a/docs/Introduction.rst b/docs/Introduction.rst index dc05c8725..4490086f3 100644 --- a/docs/Introduction.rst +++ b/docs/Introduction.rst @@ -7,14 +7,15 @@ Introduction and Overview DFHack is a Dwarf Fortress memory access library, distributed with a wide variety of useful scripts and plugins. -The project is currently hosted at https://www.github.com/DFHack/dfhack, -and can be downloaded from `the releases page -`_. +The project is currently hosted `on GitHub `_, +and can be downloaded from `the releases page `_ +- see `installing` for installation instructions. This is also where the +`DFHack bug tracker `_ is hosted. -All new releases are announced in :forums:`the bay12 forums thread <139553>`, +All new releases are announced in `the Bay12 forums thread `_, which is also a good place for discussion and questions. -For users, it provides a significant suite of bugfixes and interface +For users, DFHack 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! @@ -27,7 +28,7 @@ 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. +`various open-source licences `, contributions are welcome. .. contents:: Contents diff --git a/index.rst b/index.rst index df28d0778..d5c7fbc10 100644 --- a/index.rst +++ b/index.rst @@ -2,33 +2,23 @@ Welcome to DFHack's documentation! ################################## -Introduction -============ -DFHack is a Dwarf Fortress memory access library, distributed with -a wide variety of useful scripts and plugins. +DFHack is a memory editing library for `Dwarf Fortress `_ +that provides a unified, cross-platform environment where tools can be developed +to extend the game. The default distribution contains a variety of tools, including +bugfixes, interface improvements, automation tools, modding tools, and more. +There are also a variety of third-party tools available. -The project is currently hosted at https://www.github.com/DFHack/dfhack, -and can be downloaded from `the releases page -`_. +.. _quick-links: -All new releases are announced in :forums:`the bay12 forums thread <139553>`, -which is also a good place for discussion and questions. - -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-modtools` -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. +Quick Links +=========== +* `Downloads `_ +* `Installation guide ` +* `Source code `_ + (**important:** read `compile` before attempting to build from source) +* `Bay 12 forums thread `_ +* `Bug tracker `_ User Manual ===========