diff options
| author | Arjun Satarkar <me@arjunsatarkar.net> | 2023-12-31 19:02:21 +0000 |
|---|---|---|
| committer | Arjun Satarkar <me@arjunsatarkar.net> | 2023-12-31 19:02:21 +0000 |
| commit | 5f8e6d6d7f4fa2a5a51be95fb4aa7f15136b8785 (patch) | |
| tree | 9890f8e4c3d3b1a6a9b9b3ee4990d605afcfab28 /README.adoc | |
| parent | 0db3a6e7014011eddeddfd69ac12b80d23a1f019 (diff) | |
| download | terminal-lcd-clock-5f8e6d6d7f4fa2a5a51be95fb4aa7f15136b8785.tar terminal-lcd-clock-5f8e6d6d7f4fa2a5a51be95fb4aa7f15136b8785.tar.gz terminal-lcd-clock-5f8e6d6d7f4fa2a5a51be95fb4aa7f15136b8785.zip | |
Add license and README
Diffstat (limited to 'README.adoc')
| -rw-r--r-- | README.adoc | 20 |
1 files changed, 20 insertions, 0 deletions
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 +.... |