-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
# 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
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,
% 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**
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",
"Topic :: Utilities"
],
)
-