rattail/rattail-tutorial
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

docs: use markdown for readme file

Browse source
This commit is contained in:
Lance Edgar 2024-09-13 18:21:24 -05:00
parent b96c828fa3
commit 70b103ebd8
2 changed files with 3 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
README.rst → README.md
View file

@ -1,13 +1,9 @@
.. -*- mode: rst -*-
rattail-tutorial # rattail-tutorial
================
This project is intended for use as a "tutorial" for Rattail app development. This project is intended for use as a "tutorial" for Rattail app development.
It contains documentation for the tutorial itself, but also contains It contains documentation for the tutorial itself, but also contains
code for the tutorial app, which users may run locally for testing. code for the tutorial app, which users may run locally for testing.
See the `Rattail website`_ for more info. See the [Rattail website](https://rattailproject.org/) for more info.
.. _`Rattail website`: https://rattailproject.org/

2
pyproject.toml
View file

@ -8,7 +8,7 @@ build-backend = "hatchling.build"
name = "rattail-tutorial" name = "rattail-tutorial"
version = "0.3.1" version = "0.3.1"
description = "Rattail Development Tutorial" description = "Rattail Development Tutorial"
readme = "README.rst" readme = "README.md"
authors = [{name = "Lance Edgar", email = "lance@edbob.org"}] authors = [{name = "Lance Edgar", email = "lance@edbob.org"}]
license = {text = "GNU GPL v3+"} license = {text = "GNU GPL v3+"}
classifiers = [ classifiers = [