From 70b103ebd84fc5afb5ec93ebda14a72c41fdf1d0 Mon Sep 17 00:00:00 2001 From: Lance Edgar Date: Fri, 13 Sep 2024 18:21:24 -0500 Subject: [PATCH] docs: use markdown for readme file --- README.rst => README.md | 8 ++------ pyproject.toml | 2 +- 2 files changed, 3 insertions(+), 7 deletions(-) rename README.rst => README.md (59%) diff --git a/README.rst b/README.md similarity index 59% rename from README.rst rename to README.md index 1d15628..d8b38c1 100644 --- a/README.rst +++ b/README.md @@ -1,13 +1,9 @@ -.. -*- mode: rst -*- -rattail-tutorial -================ +# rattail-tutorial This project is intended for use as a "tutorial" for Rattail app development. It contains documentation for the tutorial itself, but also contains code for the tutorial app, which users may run locally for testing. -See the `Rattail website`_ for more info. - -.. _`Rattail website`: https://rattailproject.org/ +See the [Rattail website](https://rattailproject.org/) for more info. diff --git a/pyproject.toml b/pyproject.toml index 1beb55c..f70a108 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -8,7 +8,7 @@ build-backend = "hatchling.build" name = "rattail-tutorial" version = "0.3.1" description = "Rattail Development Tutorial" -readme = "README.rst" +readme = "README.md" authors = [{name = "Lance Edgar", email = "lance@edbob.org"}] license = {text = "GNU GPL v3+"} classifiers = [