diff options
author | John MacFarlane <jgm@berkeley.edu> | 2017-12-29 16:41:51 -0800 |
---|---|---|
committer | John MacFarlane <jgm@berkeley.edu> | 2017-12-29 16:41:51 -0800 |
commit | 81b0b208278ea8982d6581bda0dc922c466df2a9 (patch) | |
tree | 6f7d39e01586780dfd0400aa709e3dacd94fbe70 /README.template | |
parent | 0d968c4bbbd9e9b718d6fa63814419866e670c95 (diff) | |
download | pandoc-81b0b208278ea8982d6581bda0dc922c466df2a9.tar.gz |
Generate README.md from template and MANUAL.txt.
`make README.md` will generate the README.md after changes
to MANUAL.txt have been made.
Diffstat (limited to 'README.template')
-rw-r--r-- | README.template | 54 |
1 files changed, 54 insertions, 0 deletions
diff --git a/README.template b/README.template new file mode 100644 index 000000000..839e6dfe0 --- /dev/null +++ b/README.template @@ -0,0 +1,54 @@ +<!-- Do not edit this file. It is generated automatically from +README.template and MANUAL.txt via the command: +pandoc --lua-filter tools/update-readme.lua README.template -o README.md +--> + +Pandoc +====== + +[![github release](https://img.shields.io/github/release/jgm/pandoc.svg?label=current+release)](https://github.com/jgm/pandoc/releases) +[![hackage release](https://img.shields.io/hackage/v/pandoc.svg?label=hackage)](http://hackage.haskell.org/package/pandoc) +[![homebrew](https://img.shields.io/homebrew/v/pandoc.svg)](http://brewformulas.org/Pandoc) +[![stackage LTS package](http://stackage.org/package/pandoc/badge/lts)](http://stackage.org/lts/package/pandoc) +[![travis build status](https://img.shields.io/travis/jgm/pandoc/master.svg?label=travis+build)](https://travis-ci.org/jgm/pandoc) +[![appveyor build status](https://ci.appveyor.com/api/projects/status/nvqs4ct090igjiqc?svg=true)](https://ci.appveyor.com/project/jgm/pandoc) +[![license](https://img.shields.io/badge/license-GPLv2+-lightgray.svg)](https://www.gnu.org/licenses/gpl.html) +[![pandoc-discuss on google groups](https://img.shields.io/badge/pandoc-discuss-red.svg?style=social)](https://groups.google.com/forum/#!forum/pandoc-discuss) + + +The universal markup converter +------------------------------ + +::: description +::: + +Installing +---------- + +Here's [how to install pandoc](INSTALL.md). + +Documentation +------------- + +Pandoc's website contains a full [User's Guide](https://pandoc.org/MANUAL.html). +It is also available [here](MANUAL.txt) as pandoc-flavored Markdown. +The website also contains some [examples of the use of +pandoc](https://pandoc.org/demos.html) and a limited [online +demo](https://pandoc.org/try). + +Contributing +------------ + +Pull requests, bug reports, and feature requests are welcome. Please make +sure to read [the contributor guidelines](CONTRIBUTING.md) before opening a +new issue. + + +License +------- + +© 2006-2017 John MacFarlane (jgm@berkeley.edu). Released under the +[GPL], version 2 or greater. This software carries no warranty of +any kind. (See COPYRIGHT for full copyright and warranty notices.) + +[GPL]: http://www.gnu.org/copyleft/gpl.html "GNU General Public License" |