renaming, readme

2022-03-26 10:40:46 +01:00
parent 08536d7949
commit 58cd5cc5de
4 changed files with 50 additions and 4 deletions
--- a/README.md
+++ b/README.md
@@ -1 +1,47 @@
-# shotclock
+# shtclck
+
+A shotclock app for pool players according to the Mosconi Cup rules:
+
+> Each player has up to 30 seconds to complete each
+> shot. The clock will start when the last moving ball
+> on the table comes to rest. Failure to play a shot in
+> the allocated time will result in loss of visit and cue
+> ball in hand to the incoming player.
+> After the break shot, a player can take a maximum
+> of 60 seconds to appraise the table. The clock will
+> start after the completion of the first shot in open
+> play.
+> Each Player (singles) or team (doubles) is allowed
+> one 30-second extension per rack. This can be called
+> at any time within the initial 30 seconds.
+> (https://matchroompool.com/programmes/MosconiCup2020.pdf)
+
+Get started at https://shtclck.org
+
+## authors notes
+
+- fully intended to be used on mobile devices
+- it works on my machine ;)
+- yep, it's a `table` layout. don't blame me, i'm a backend dev :D
+
+## how it works
+
+- just give it a try. :) 
+- most elements are clickable and some more actions are triggered on a "long press" event.
+- it's intended for the device to be fullscreen and landscape oriented. 
+
+## issues / suggestions / ...
+
+- feel free to create an issue on this project!
+
+## credits to:
+
+- Krafti Lab for "Seven Segment" font (https://www.cdnfonts.com/seven-segment.font)
+- unknown for "Profession" font family (https://www.cdnfonts.com/profession.font)
+- Font Awesome for the icons (https://fontawesome.com/)
+- Delapouite for template of the 12-ball-logo (https://commons.wikimedia.org/wiki/File:136_Bilardo.svg)
+- Stack Overflow for 
+  - https://stackoverflow.com/questions/5047346/converting-strings-like-document-cookie-to-objects
+  - https://stackoverflow.com/questions/6139225/how-to-detect-a-long-touch-pressure-with-javascript-for-android-and-iphone
+  - https://stackoverflow.com/questions/879152/how-do-i-make-javascript-beep
+  - and many more open tabs :)
--- a/index.html
+++ b/index.html
@@ -7,7 +7,7 @@
          integrity="sha512-KfkfwYDsLkIlwQp6LFnl8zNdLGxu9YAA1QvwINks4PhcElQSvqcyVLLD9aMhXd13uQjoXtEKNosOWaZqXgel0g=="
          referrerpolicy="no-referrer" rel="stylesheet"/>

-    <link href="shotclock.css" rel="stylesheet">
+    <link href="shtclck.css" rel="stylesheet">
 </head>
 <body>

@@ -15,7 +15,7 @@

    <thead>
    <tr>
-        <th colspan="3">Shotclock</th>
+        <th colspan="3">shtclck</th>
    </tr>
    </thead>

@@ -147,6 +147,6 @@
    </tfoot>

 </table>
-<script src="shotclock.js" type="text/javascript"></script>
+<script src="shtclck.js" type="text/javascript"></script>
 </body>
 </html>
--- a/shotclock.css
+++ b/shotclock.css
--- a/shotclock.js
+++ b/shotclock.js