Update slogan and packaging info

diff --git a/LICENSE b/LICENSE
index e1300da69efe0f04bfd5234b886741db7b6a2d2f..9bdb3889968f1d0228f9f87987f88a43dcd956db 100644 (file)
--- a/LICENSE
+++ b/LICENSE
@@ -1,4 +1,4 @@
-Lightcards - Simple flashcards in the terminal
+Lightcards - Terminal flashcards from Markdown
 Copyright © 2021 Armaan Bhojwani <me@armaanb.net>
 
 Permission is hereby granted, free of charge, to any person obtaining

diff --git a/README.md b/README.md
index 88c6d73d4063de9e87d4d8c6579b25c3fdc44940..b9250f9ddbc9ff65017e25885c8fb90f600d6483 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,8 +1,11 @@
 # lightcards
-Lightcards is a terminal program for using flashcards from a Markdown or HTML table. Currently under development.
+Terminal flashcards from Markdown.
 
 # Installation
 `make`
 
+# Usage
+see `lightcards --help`
+
 ## License
 Copyright Armaan Bhojwani 2021, MIT license

diff --git a/lightcards/lightcards.py b/lightcards/lightcards.py
index ca3eac83d1d0a6bbe897085bda1061a5922ad2e5..45a1e8485681d52e1fe217ef6b800665579fca30 100755 (executable)
--- a/lightcards/lightcards.py
+++ b/lightcards/lightcards.py
@@ -12,7 +12,7 @@ from .deck import Status
 
 
 def parse_args():
-    parser = argparse.ArgumentParser(description="Simple terminal flashcards")
+    parser = argparse.ArgumentParser(description="Terminal flashcards from Markdown")
     parser.add_argument("inp",
                         metavar="input file",
                         type=str,

diff --git a/man/lightcards.1.md b/man/lightcards.1.md
index 5fc0aed6810459e6387546752adc35f6a2aea691..0536fbf0003eb7eca04ee52f65449e78967085d2 100644 (file)
--- a/man/lightcards.1.md
+++ b/man/lightcards.1.md
@@ -3,13 +3,13 @@
 % January 2021
 
 # NAME
-Lightcards - simple terminal flashcards.
+lightcards - terminal flashcards from Markdown
 
 # SYNOPSIS
 lightcards [[options]] [input file]
 
 # DESCRIPTION
-**lightcards** is a Python program that reads data from a two column Markdown or HTML table, and displays flashcards based on their contents.
+**lightcards** is a Python program that reads data from a two column Markdown (and by extension, HTML) table, and displays flashcards from their contents.
 
 # POSITIONAL ARGUMENTS
 **input file**

diff --git a/setup.py b/setup.py
index 2e9f881b57c26bda7e51d07079dd945dcec9fbac..50b85c1048bd1eba5fe3c4601402d5ccf03d6acb 100644 (file)
--- a/setup.py
+++ b/setup.py
@@ -1,9 +1,16 @@
 from setuptools import setup
+from os import path
+
+pwd = path.abspath(path.dirname(__file__))
+with open(path.join(pwd, "README.md"), encoding="utf-8") as f:
+    long_description = f.read()
 
 setup(
     name="lightcards",
     version="0.2.0",
-    description="Markdown flashcards",
+    description="Terminal flashcards from Markdown",
+    long_description=long_description,
+    long_description_content_type="text/markdown",
     url="https://sr.ht/~armaan/lightcards",
     author="Armaan Bhojwani",
     author_email="me@armaanb.net",
@@ -18,4 +25,3 @@ setup(
         "Topic :: Utilities"
     ],
 )
-