From 0c92738c36b4f1707352a14bfe69a3c75fd2440c Mon Sep 17 00:00:00 2001 From: Max Magorsch Date: Sat, 25 Jan 2020 22:36:03 +0100 Subject: Update the documentation in the README Signed-off-by: Max Magorsch --- README.md | 26 +++++++++++++++++++++++--- 1 file changed, 23 insertions(+), 3 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 32b3aa3..cb65573 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,17 @@ -# Tyrian Sphinx Theme +

+

-A Sphinx theme based on Tyrian (the new unified gentoo.org theme). +

+ + +PyPI version + + +

+## Table Of Contents +- [Basic Overview](#basic-overview) - [Installation](#installation) - [Configuration](#configuration) - [builders](#builders) @@ -13,6 +22,13 @@ A Sphinx theme based on Tyrian (the new unified gentoo.org theme). - [license](#license) - [license_link](#license_link) - [Contributors](#contributors) +- [Contributing](#contributing) + +## Basic Overview + +A Sphinx theme based on Tyrian (the new unified gentoo.org theme). + +[![Screenshoot](https://raw.githubusercontent.com/mmagorsc/taskmonad/master/docs/screenshot.png)](https://projects.gentoo.org/qa/policy-guide/) ## Installation You can use pip to install the theme: @@ -69,4 +85,8 @@ $ sphinx-build -b singlehtml ... - https://creativecommons.org/licenses/by-sa/4.0/ *(default)* ## Contributors -* [Max Magorsch](mailto:max@magorsch.de) \ No newline at end of file +* [Max Magorsch](mailto:max@magorsch.de) + +## Contributing + +Contributions are welcome. You have an idea, suggestion for improvement or have found a bug? Just create an issue or send a pull request. \ No newline at end of file -- cgit v1.2.3-65-gdbad