Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
shotwn committed Sep 13, 2019
1 parent 7469589 commit d7f23c0
Showing 1 changed file with 35 additions and 2 deletions.
37 changes: 35 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,48 @@
<!-- PROJECT LOGO -->

<a href="https://gitlab.com/shotwn/zz-cat/">
<img src="https://assets.gitlab-static.net/uploads/-/system/project/avatar/14297459/bg.avatar.png" alt="Logo" width="80" height="80">
<img src="https://assets.gitlab-static.net/uploads/-/system/project/avatar/14297459/bg.avatar.png" alt="Logo" width="80" height="80" />
</a>

<h3 align="center">zz Cat</h3>

** ..is a shutdown timer. **

**...is a shutdown timer**

*Don't reinvent the stone. Use the this fluffy tool.*

<a href="https://gitlab.com/shotwn/zz-cat/issues">Report Bug</a>
·
<a href="https://gitlab.com/shotwn/zz-cat/issues">Request Feature</a>

## About
I like to keep my computer on when going to sleep. What can I say, I like to sleep watching something.
But I don't like to keep my computer on sleep all night; that is, if it goes to sleep automatically.

I've always written bat scripts to turn off my PC after certain amount of time.
But I always lose them. This time I wanted to write all using autohotkey.
I know, I know.. There are dozens of scripts I can choose from after a simple google search but hey ! My AHK "knowledge" required a repeat anyway.

And here we go, we have this snippet of a script.

## Features
- It can turn **off your monitor**. Take your computer to **Sleep**, **Hibernation** or **Shutdown** states.
- It has a timer with *seperate hour, minute and second inputs.*
- It has the countdown on a small window, with a huge cancel button on it.
- 10 seconds before set action, it maximizes the countdown window to give *user* an **action movie slam abort** chance.
- If computer goes to sleep before zz Cat puts it to sleep, kitty will cancel the countdown and shut itself off silently.
- You can use it with only keyboard inputs.
- It kinda looks cute.

## Usage
1. Select what you want to happen from first window.
2. Enter values for countdown. (Enter key confirms it)
3. Watch the countdown pointlessly, or **GO TO BED**. (ESC aborts it)

## Thx
[GoodFreePhotos for the public domain vector image.](https://www.goodfreephotos.com/vector-images/sleeping-kitty-vector-clipart.png.php)

## FAQ
* No I don't see cute-ish design as a thread to my masculinity.
* I am a dog person but I love cats immensely too. "Sleepy Cat" is a nickname for me, but it was taken already.
* Yes I like ZZ Top.

0 comments on commit d7f23c0

Please sign in to comment.