From 691525d47e162525a9f0a179c02dab493cbea940 Mon Sep 17 00:00:00 2001 From: Armaan Bhojwani Date: Sun, 31 Jan 2021 00:08:32 -0500 Subject: [PATCH] Update slogan and packaging info --- LICENSE | 2 +- README.md | 5 ++++- lightcards/lightcards.py | 2 +- man/lightcards.1.md | 4 ++-- setup.py | 10 ++++++++-- 5 files changed, 16 insertions(+), 7 deletions(-) diff --git a/LICENSE b/LICENSE index e1300da..9bdb388 100644 --- a/LICENSE +++ b/LICENSE @@ -1,4 +1,4 @@ -Lightcards - Simple flashcards in the terminal +Lightcards - Terminal flashcards from Markdown Copyright © 2021 Armaan Bhojwani Permission is hereby granted, free of charge, to any person obtaining diff --git a/README.md b/README.md index 88c6d73..b9250f9 100644 --- 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 ca3eac8..45a1e84 100755 --- 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 5fc0aed..0536fbf 100644 --- 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 2e9f881..50b85c1 100644 --- 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" ], ) - -- 2.39.2