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

20 lines
1.1 KiB
Markdown
Raw Normal View History Unescape Escape

README.md: Fix broken markdown links and header. Github's markdown parser does not permit newlines between link titles and link text. This change removes the newlines, resulting in a less pleasing source, but one which renders when viewed on github. Github also requires a space between the '#' and text of headings, so we fix that, too.
2017-03-26 17:59:09 -06:00
# DFHack Readme
Split GitHub README from Sphinx index 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.
2015-10-27 17:06:28 -06:00
README.md: Fix broken markdown links and header. Github's markdown parser does not permit newlines between link titles and link text. This change removes the newlines, resulting in a less pleasing source, but one which renders when viewed on github. Github also requires a space between the '#' and text of headings, so we fix that, too.
2017-03-26 17:59:09 -06:00
[![Build Status](https://travis-ci.org/DFHack/dfhack.svg?branch=develop)](https://travis-ci.org/DFHack/dfhack)
[![Documentation Status](https://readthedocs.org/projects/dfhack/badge)](https://dfhack.readthedocs.org)
[![License](https://img.shields.io/badge/license-ZLib-blue.svg)](https://en.wikipedia.org/wiki/Zlib_License)
[![Github Issues](http://githubbadges.herokuapp.com/DFHack/dfhack/issues)](https://github.com/DFHack/dfhack/issues)
[![Open Pulls](http://githubbadges.herokuapp.com/DFHack/dfhack/pulls)](https://github.com/DFHack/dfhack/pulls)
Split GitHub README from Sphinx index 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.
2015-10-27 17:06:28 -06:00
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](https://dfhack.readthedocs.org),
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.
README.md: Fix broken markdown links and header. Github's markdown parser does not permit newlines between link titles and link text. This change removes the newlines, resulting in a less pleasing source, but one which renders when viewed on github. Github also requires a space between the '#' and text of headings, so we fix that, too.
2017-03-26 17:59:09 -06:00
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.