From 4356d20652cc388f5f85e57b5e49034ef73f9bdf Mon Sep 17 00:00:00 2001 From: Lance Edgar Date: Fri, 13 Sep 2024 19:31:09 -0500 Subject: [PATCH] docs: use markdown for readme file --- README.md | 11 +++++++++++ README.txt | 13 ------------- pyproject.toml | 2 +- 3 files changed, 12 insertions(+), 14 deletions(-) create mode 100644 README.md delete mode 100644 README.txt diff --git a/README.md b/README.md new file mode 100644 index 0000000..5648c9d --- /dev/null +++ b/README.md @@ -0,0 +1,11 @@ + +# rattail-cognitive + +Rattail is a retail software framework, released under the GNU General Public +License. + +This package contains hardware interfaces for +[Cognitive](http://www.cognitive.com/) devices. + +Please see Rattail's [home page](https://rattailproject.org/) for more +information. diff --git a/README.txt b/README.txt deleted file mode 100644 index f675812..0000000 --- a/README.txt +++ /dev/null @@ -1,13 +0,0 @@ - -rattail-cognitive -================= - -Rattail is a retail software framework, released under the GNU General Public -License. - -This package contains hardware interfaces for `Cognitive`_ devices. - -Please see Rattail's `home page`_ for more information. - -.. _Cognitive: http://www.cognitive.com/ -.. _home page: https://rattailproject.org/ diff --git a/pyproject.toml b/pyproject.toml index cec10d3..0742c23 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -8,7 +8,7 @@ build-backend = "hatchling.build" name = "rattail_cognitive" version = "0.4.0" description = "Hardware Interfaces for Cognitive Devices" -readme = "README.txt" +readme = "README.md" authors = [{name = "Lance Edgar", email = "lance@edbob.org"}] license = {text = "GNU GPL v3+"} classifiers = [