From 5f8e6d6d7f4fa2a5a51be95fb4aa7f15136b8785 Mon Sep 17 00:00:00 2001
From: Arjun Satarkar <me@arjunsatarkar.net>
Date: Mon, 1 Jan 2024 00:32:21 +0530
Subject: Add license and README

---
 README.adoc | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)
 create mode 100644 README.adoc

(limited to 'README.adoc')

diff --git a/README.adoc b/README.adoc
new file mode 100644
index 0000000..dd08142
--- /dev/null
+++ b/README.adoc
@@ -0,0 +1,20 @@
+= Terminal LCD Clock
+
+A simple justified time and date LCD-like display using https://github.com/pwaller/pyfiglet:[pyfiglet] and curses.
+
+image::https://scm.arjunsatarkar.net/terminal-lcd-clock/plain/example.png[Screenshot]
+
+== License
+
+MIT; see LICENSE.txt in the repository root.
+
+== Usage
+Prerequisites: https://www.python.org/downloads/[Python 3].
+
+After cloning the repo and ``cd``ing in:
+....
+python3 -m venv venv
+source venv/bin/activate
+pip install -r requirements.txt
+./terminal_clock.py
+....
-- 
cgit v1.2.3-57-g22cb

