Skip to content
This repository has been archived by the owner on Jul 11, 2022. It is now read-only.

Commit

Permalink
Emojified README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ggustafsson committed Apr 22, 2022
1 parent 9791b7c commit da7ce4b
Showing 1 changed file with 17 additions and 12 deletions.
29 changes: 17 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,43 +1,43 @@
# Tim (Timer Script)
# Tim (Timer Script)

![Screenshot](https://github.com/ggustafsson/Project-Assets/raw/master/Tim/Screenshot.png)

## Description
## 🚨 Description

Terminal countdown timer with several modes written in Zsh shell script.
Currently Tim got a countdown timer, interval timer, pomodoro timer and magical
powers.

## Usage
## 🚀 Usage

It's really easy to play with Tim. Just run the script!

./tim --help

## Installation
## 📦 Installation

All you need to do is move the file **tim** to a directory in your shell path
All you need to do is move the file **tim** to a directory in your shell PATH
and move the directory **audio_files** to **~/.tim** (this is only needed if
you want to use the default alarm commands and files). If you want to specify
your own commands then you can just move **timrc.example** to **~/.timrc** and
edit the various variables.
edit the settings.

## Configuration
## ⚙️ Configuration

Read the comments in the file **timrc.example** for more information.
Read comments in file **timrc.example** for more information.

## Dependencies
## 🐚 Dependencies

You need to have **Zsh** installed to run this.

When using the default settings Tim depends on:
When using default settings Tim depends on:

- macOS:
- **afplay** - Comes with macOS.
- Linux:
- **aplay** - Comes with alsa-utils.

## Tips
## 🦄 Tips

If you use macOS you can put this in **~/.timrc** to make it speak:

Expand All @@ -62,7 +62,12 @@ Or if you need to celebrate after a pomodoro session:
pomodoro_cmd="open rick-roll.avi" # macOS
pomodoro_cmd="mplayer rick-roll.avi" # Linux

## License
## ⚠️ Quirks

Writing a tool like this in Zsh is completely insane. It makes no sense at all.
But here we are and this, my own Frankenstein's monster, is a beautiful beast.

## 📜 License

Released under the BSD 3-Clause License.

Expand Down

0 comments on commit da7ce4b

Please sign in to comment.