From: Armaan Bhojwani Date: Wed, 17 Feb 2021 17:18:49 +0000 (-0500) Subject: First commit X-Git-Url: https://git.armaanb.net/?p=lightcards-gemini.git;a=commitdiff_plain;h=4007ebd44e2f4f9a73e0d2441c6683939e6cb907 First commit --- 4007ebd44e2f4f9a73e0d2441c6683939e6cb907 diff --git a/.build.yml b/.build.yml new file mode 100644 index 0000000..8ed8033 --- /dev/null +++ b/.build.yml @@ -0,0 +1,6 @@ +image: alpine/edge +secrets: + - 5752743f-34af-46a8-aad9-b5d31e305b3b +tasks: + - ssh: | + ssh -o StrictHostKeyChecking=no -p 23 web@armaanb.net "web-update-server lightcards-gemini" diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..d2dbb85 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +lightcards*.*.gmi diff --git a/.gmi b/.gmi new file mode 100644 index 0000000..ce8f949 --- /dev/null +++ b/.gmi @@ -0,0 +1,19 @@ +-------------------------------------------------------------------------------- + +title: lightcards-config section: 5 header: File Formats Manual footer: VERSION_HERE date: February 2021 + +-------------------------------------------------------------------------------- + +# NAME + +lightcards-config - configuration file formats for **lightcards(1)** + +# CONFIGURATION + +Configuration is done through the config.py file. This is an executed Python script and must have valid Python syntax. Whilst this does have some drawbacks of being stricter on syntax, it also allows you to do things such as appending values to lists instead of overwriting them, and using logic within the configuration through actual Python code. + +Copy the global config file from /etc/lightcards/config.py to ~/.config/lightcards/config.py or $XDG_CONFIG_HOME/lightcards/config.py and make modifications! All possible options are listed in the global config file. + +# SEE ALSO + +**lightcards(1)** diff --git a/1.webp b/1.webp new file mode 100644 index 0000000..738306d Binary files /dev/null and b/1.webp differ diff --git a/2.webp b/2.webp new file mode 100644 index 0000000..1c24d20 Binary files /dev/null and b/2.webp differ diff --git a/3.webp b/3.webp new file mode 100644 index 0000000..3978314 Binary files /dev/null and b/3.webp differ diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..5c688a3 --- /dev/null +++ b/LICENSE @@ -0,0 +1,20 @@ +Lightcards Gemini capsule +Copyright © 2021 Armaan Bhojwani + +Permission is hereby granted, free of charge, to any person obtaining +a copy of this software and associated documentation files (the "Software"), +to deal in the Software without restriction, including without limitation +the rights to use, copy, modify, merge, publish, distribute, sublicense, +and/or sell copies of the Software, and to permit persons to whom the +Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included +in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES +OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. +IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, +DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, +TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE +OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..78c3836 --- /dev/null +++ b/Makefile @@ -0,0 +1,4 @@ +.DEFAULT_GOAL := minify + +minify: + ./convert diff --git a/README.md b/README.md new file mode 100644 index 0000000..095be80 --- /dev/null +++ b/README.md @@ -0,0 +1,6 @@ +# Lightcards Gemini capsule + +Gemini capsule for [lightcards](https://git.sr.ht/~armaan/lightcards) + +## License +Copyright 2021 Armaan Bhojwani, MIT license. diff --git a/convert b/convert new file mode 100755 index 0000000..a92c169 --- /dev/null +++ b/convert @@ -0,0 +1,12 @@ +#!/usr/bin/env bash + +curl -O https://git.sr.ht/~armaan/lightcards/blob/main/man/lightcards.1 +curl -O https://git.sr.ht/~armaan/lightcards/blob/main/man/lightcards-config.5 + +find . -type f -name 'lightcards**' -not -name '*gmi*' | \ + while read i; do + base=$(basename ${i} | cut -d '.' -f -2) + pandoc ${i} -t markdown | md2gemini > ${base}.gmi + sed -i -e 's/[*]//g' -e 's/^\: */ /g' ${base}.gmi + rm ${i} + done diff --git a/index.gmi b/index.gmi new file mode 100644 index 0000000..bc79665 --- /dev/null +++ b/index.gmi @@ -0,0 +1,37 @@ +# lightcards +A terminal flashcards program that gets its data from Markdown. + +=>https://sr.ht/~armaan/lightcards Source code +=>https://lists.sr.ht/~armaan/public-inbox Mailing list +=>https://pypi.org/project/lightcards PyPI + +## Installation +Lightcards is only tested and maintained on Linux. Support for other Unix-like operating systems such as MacOS and the various BSDs is likely, although untested. Lightcards requires Python 3.9. + +### From PyPI +```sh +pip install lightcards +``` + +### From Git +Main branch (stable) +```sh +pip install git+https://git.sr.ht/~armaan/lightcards +```sh + +Development branch +```sh +pip install git+https://git.sr.ht/~armaan/lightcards@devel +``` + +## Manpages +=>lightcards.1.gmi lightcards(1) +=>lightcards-config.5.gmi lightcards-config(5) + +## Gallery +=>1.webp screenshot 1 (image/webp) +=>2.webp screenshot 2 (image/webp) +=>3.webp screenshot 3 (image/webp) + +## Copyright +Copyright 2021 Armaan Bhojwani, MIT license.