Commit Graph

111 Commits (5a1e5e1464eed1c8d2e16c75ea4624e7d346b9d2)

Author SHA1 Message Date
TheBloke 5b1e2ff01f Windows: soften the recommendation on Chocolatey to a 'preferred', also some improvements on the Chocolatey description re behaviour when software is already installed. And an update to the Manual Dependencies section. 2015-12-19 14:17:39 +00:00
TheBloke 03ec774142 OSX: fixed wording on DF path 2015-12-19 02:39:03 +00:00
TheBloke 7bfeb7cb2b OSX: Removed dupe statement 2015-12-19 02:37:31 +00:00
TheBloke 895d5a534e Fixes to: Linux: gcc-multilib; OSX: 10.11 notes higher/more emphasised; Windows: reason for why SP1 is required (currently unknown, so downgraded to 'we do not support' rather than a specific reason why it won't work. 2015-12-19 01:59:23 +00:00
TheBloke e3b7cace60 Some re-wording in Building The Documentation, including some 80-char width (approx) re-formatting. 2015-12-15 22:04:10 +00:00
TheBloke 9bc8368d29 Further tweak to Enable documentation build re setting CMAke flag: mention GUI, update Windows advice. 2015-12-15 20:30:11 +00:00
TheBloke 6c7e5c9428 A few additions to the Windows section; more formatting changes including command highlighting; misc other tweaks. 2015-12-15 20:21:22 +00:00
TheBloke 196aec4cb4 + again 2015-12-15 18:51:37 +00:00
TheBloke 2ded0e5ea9 Github->GitHub; git->Git (where not a command); one more change to Perlbrew section 2015-12-15 18:50:59 +00:00
TheBloke e1777fcc6b OSX: Simplify the new local Perl section, just mention what perlbrew as it's obvious enough how to use it from the webpage and most people probably won't be interested anyway. 2015-12-15 14:16:51 +00:00
TheBloke 417f9a26aa Minor bullet point fixes in Mac list 2015-12-15 07:06:23 +00:00
TheBloke 1f928a8292 Typo 2015-12-15 06:16:48 +00:00
TheBloke 1afc0afb9c Some further fixes, updates and elaborations. Had to convert the Mac list to bullet rather than numbered, as HTML numbering keeps breaking (resets to 1 in the middle of the list in several places) for reasons I can't figure out. 2015-12-15 06:08:25 +00:00
TheBloke f26982f1e9 And other minor fixes (actually in this commit this time.) 2015-12-15 04:11:39 +00:00
TheBloke 5aae535394 Building documentation section: now with a non-stupid way of doing it! And other minor fixes. 2015-12-15 04:10:00 +00:00
TheBloke 21631b3712 Compile.rst: major updates to Windows and OSX sections; minor to Linux; new section re compiling documentation; many small fixes.
Introduction.rst: fix typo and remove erroneous end version for OSX.
2015-12-15 03:30:08 +00:00
lethosor df61233774 Merge remote-tracking branch 'PeridexisErrant/new-scripts' into develop 2015-11-26 16:13:27 -05:00
lethosor 75f43b9bf6 Add @Enkrod to Authors.rst
Ref #743
2015-11-26 10:54:35 -05:00
Lethosor d18dae45d8 Merge pull request #743 from Enkrod/patch-2
Typo Restrictliquid fixed
2015-11-26 10:52:57 -05:00
lethosor 597ed1510e Update documentation
Ref #741, #744, #747, #748, #749, #756
2015-11-25 20:56:30 -05:00
Eric Wald 14cf2790d2 Falconne deserves credit for a few great plugins. 2015-11-25 17:51:30 -07:00
PeridexisErrant 842b9c5191 Implement feature as a script, add magma option
Functionality is exactly equivalent to the plugin, but with a new option
for players who want to enable magma furnaces without spoilers.
2015-11-17 16:43:56 +09:30
PeridexisErrant 2ba9ef04e3 Replace drybuckets plugin with a script
Also closes #248, by checking job and building flags.
2015-11-17 13:55:43 +09:30
lethosor 9c62ff1d7f Blacklist GCC 5 on Linux again
GCC 5 mangles some symbols, such as "plugin_globals" ->
"plugin_globals[abi:c++11]" (or "_Z14plugin_globalsB5cxx11"), even
when declared with 'extern "C"'. This breaks plugins, in particular.
2015-11-10 18:51:29 -05:00
lethosor 72adb904f6 Document multilib packages 2015-11-10 16:57:38 -05:00
Sebastian Wolfertz e209e3937a Typo Restrictliquid fixed
restrictliquid is actually restrictliquids.

This time with lengthened underline for sphinx.
2015-11-10 07:50:38 +01:00
PeridexisErrant 99b93ecd11 Move index back to root 2015-11-07 19:42:18 -05:00
lethosor 52989ab40a Update Compile.rst 2015-11-07 17:18:50 -05:00
lethosor 6e8936faa7 Link to VS2010
Thanks to @TheBloke

http://stackoverflow.com/questions/3061811
2015-11-07 16:48:00 -05:00
lethosor 1da42c9115 Add automaterial label 2015-11-07 15:55:21 -05:00
lethosor e176c3ea05 Merge remote-tracking branch 'PeridexisErrant/docs-again' into develop 2015-11-07 15:50:11 -05:00
PeridexisErrant 0bb203e7c9 Replace initflags plugin with scripts
Progress towards #722
2015-11-07 23:42:14 +11:00
PeridexisErrant 6dacbe3d9f Add docs for "sort" and "diggingInvaders" plugins
I don't know how these were missed, but I've now checked everything
listed by "plug" but not (previously) a heading in Plugins.rst
2015-11-07 17:05:57 +11:00
PeridexisErrant 3d801d45c6 Flatten plugin documentation
The obvious solution to not knowing how to categories plugins well is to
do so a little less.  This commit does not rearrange them though, since
I thought that counterproductive without a better idea of what to do.

- removed many headings that are not commands
- fixed a few links and added some
- clarified stockpiles plugins
2015-11-07 14:01:18 +11:00
PeridexisErrant 1c25f8f1a3 Unify docs for designation and map-mod plugins
Plus some cleanup and flattening of the behaviour mod plugin docs
2015-11-07 13:04:47 +11:00
PeridexisErrant a1110b36e8 Add shortlink for issues, update links
Also moved search above local table of contents in sidebar, which can
get very long.
2015-11-07 11:35:44 +11:00
PeridexisErrant 3506921447 Add cross-links for similar commands 2015-11-07 10:53:12 +11:00
PeridexisErrant 7f212178ca Move unused docs to plugin source files
This way they can easily be restored when the plugins are reactivated,
but don't confuse users until then.
2015-11-07 10:13:21 +11:00
PeridexisErrant 5826b49d09 Move index.rst to docs directory
Having the docs index in the repo root was a holdover from when it was
the README file.  Now that it's not much use without being built, it's
better to leave the root to README, NEWS, and LICENSE - especially when
one is a html shortcut to the docs index.
2015-11-06 17:09:56 +11:00
PeridexisErrant 193e71793a Fix compile, intro, scripts
- script-syntax.py now exits with 1 instead of silently catching the
error if lua or ruby are missing
- index paths are absolute (from the repo root)
- less strong suggestion for third-party packs
- re-added lua-example and test-perlin doc
- corrected and clarified Compile some more
2015-11-06 16:58:58 +11:00
PeridexisErrant bc91928f8d Explain ":foo" parsing mode in Core notes 2015-11-06 11:58:33 +11:00
Lethosor 2f8f5b071a Merge pull request #730 from PeridexisErrant/add-scripts
Add updated emigration script, gui/family-affairs
2015-11-05 19:55:15 -05:00
PeridexisErrant 18a921baef Further clarify Core; move plugins out; other fixes
- Fix formatting of (c) in license
- Avoid possible issues with script linting
- Move plugin docs out of Core.rst
- Fix some builtin docs, tweak other bits
2015-11-06 11:44:43 +11:00
lethosor 7fc2a226da Add missing backtick 2015-11-05 19:37:51 -05:00
PeridexisErrant 3cc0b34d73 Clean up other docs to match
Some deduplication in Scripts and Plugins, links in NEWS, add content
and link to files in index.
2015-11-06 10:15:21 +11:00
PeridexisErrant 0ba6f73dcd Add Introduction.rst, list builtins in Core.rst
The Introduction is the first page to read, and thus explains what
DFHack is, installation, basic use, and troubleshooting.

This frees up Core.rst for a detailed list of builtin commands (meant to
be complete, but I might have missed some), some other key commands, and
a discussion of init files.  I also put the random notes that don't fit
anywhere at the bottom of this file.
2015-11-06 10:15:21 +11:00
PeridexisErrant 3d9ba57121 Tidy and update Compile.rst
Eg removed workarounds for closed OSX bug, etc.
2015-11-06 10:15:20 +11:00
PeridexisErrant 8aafcec0c8 Add unacknowledged contributors
Mostly authors of scripts which have been added.
2015-11-06 10:15:19 +11:00
PeridexisErrant 45c3f145e5 Add gui/family-affairs 2015-11-05 13:17:26 +11:00
lethosor cbf31dcb37 Merge remote-tracking branch 'PeridexisErrant/NEWS-cleanup' into develop 2015-11-04 19:54:13 -05:00