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 | |
| parent | 0db3a6e7014011eddeddfd69ac12b80d23a1f019 (diff) | |
| download | terminal-lcd-clock-5f8e6d6d7f4fa2a5a51be95fb4aa7f15136b8785.tar terminal-lcd-clock-5f8e6d6d7f4fa2a5a51be95fb4aa7f15136b8785.tar.gz terminal-lcd-clock-5f8e6d6d7f4fa2a5a51be95fb4aa7f15136b8785.zip | |
Add license and README
| -rw-r--r-- | LICENSE.txt | 21 | ||||
| -rw-r--r-- | README.adoc | 20 | ||||
| -rw-r--r-- | example.png | bin | 0 -> 3260 bytes |
3 files changed, 41 insertions, 0 deletions
diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..dd805a2 --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2023-present Arjun Satarkar + +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.
\ No newline at end of file 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 +.... diff --git a/example.png b/example.png Binary files differnew file mode 100644 index 0000000..09aef9f --- /dev/null +++ b/example.png |
