]> git.armaanb.net Git - lightcards.git/commitdiff
Add documentation section to README
authorArmaan Bhojwani <me@armaanb.net>
Mon, 15 Feb 2021 01:53:18 +0000 (20:53 -0500)
committerArmaan Bhojwani <me@armaanb.net>
Mon, 15 Feb 2021 01:53:18 +0000 (20:53 -0500)
README.md

index 4c061d00390a704518f6f811ad9ca4d82474b895..96a6daca86c077ac66a35ce4b6039be744b094a5 100644 (file)
--- a/README.md
+++ b/README.md
@@ -22,14 +22,8 @@ pip install git+https://git.sr.ht/~armaan/lightcards
 pip install git+https://git.sr.ht/~armaan/lightcards@devel
 ```
 
-## Usage
-See `lightcards --help` or `man lightcards` for usage information.
-
-## Input file
-`contrib/example.md` is an example input file. Lightcards takes all of the tables from a valid Markdown or HTML file. Each row is a card, and the two columns are the front and back.
-
-## Configuration
-Copy the config file at `/etc/lightcards/config.py` to `~/.config/lightcards/config.py` or `~/${XDG_CONFIG_HOME}/lightcards/config.py` and edit.
+## Documentation
+All documentation aside from installation is included in the manpages. An online copy exists at [lightcards.armaanb.net](https://lightcards.armaanb.net/).
 
 ## License
 Copyright Armaan Bhojwani 2021, MIT license