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

17 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
Restrict status badge to push events only
2020-04-14 23:15:09 -06:00
[![Build Status](https://github.com/DFHack/dfhack/workflows/Build/badge.svg?event=push)](https://github.com/DFHack/dfhack/actions?query=workflow%3ABuild)
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
[![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)
Update chat links in readme (#2090) * Updates readme * Updates readme with proposed changes * Updates discord permalink to the truest permanent invite link
2022-04-10 22:38:14 -06:00
[![Discord](https://img.shields.io/discord/793331351645323264)](https://dfhack.org/discord)
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.
Clarify text and fix typos in the readme
2022-05-25 23:49:09 -06:00
The full documentation [is available online here](https://dfhack.readthedocs.org).
It is also accessible via the README.html page in the DFHack distribution or as raw text in the `./docs` folder.
Remove issue and PR badges from README.md githubbadges.herokuapp.com has been down for some time, and these badges repeated information that was already visible on https://github.com/dfhack/dfhack (and they weren't included in the generated docs either).
2019-05-21 18:22:49 -06:00
If you're an end-user, modder, or interested in contributing to DFHack -
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
go read those docs.
Clarify text and fix typos in the readme
2022-05-25 23:49:09 -06:00
If the docs are unclear or you need more help, please check out our [support page](https://docs.dfhack.org/en/latest/docs/Support.html) for ways to contact the DFHack developers.