Skip to content

Commit

Permalink
docs: update README, add theme docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Splode committed Jun 1, 2020
1 parent fb5350f commit 67109a1
Show file tree
Hide file tree
Showing 37 changed files with 97 additions and 1 deletion.
23 changes: 22 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,18 @@

[![Build Status](https://travis-ci.org/Splode/pomotroid.svg?branch=master)](https://travis-ci.org/Splode/pomotroid)

- [Overview](#overview)
- [Features](#features)
- [Themes](#themes)
- [Install](#install)
- [Download](#download)
- [Homebrew](#homebrew)
- [Scoop](#scoop)
- [Roadmap](#roadmap)
- [Development](#development)
- [Build Setup](#build-setup)
- [License](#license)

## Overview

Pomotroid is a simple and configurable Pomodoro timer. It aims to provide a visually-pleasing and reliable way to track productivity using the Pomodoro Technique.
Expand All @@ -23,9 +35,19 @@ Pomotroid is in its early stages, so feedback and contributions are welcome and
- Charming timer alert sounds (optional)
- Desktop notifications (optional)
- Minimize to tray (optional)
- Several themes included with the ability to create custom themes.
- Timer activity logging.

### Themes

Pomotroid provides many themes. It's also theme-able, allowing you to customize its appearance.

Visit the [theme documentation](./docs/themes/themes.md) to view the full list of official themes and for instruction on creating your own.

## Install

### Download

Download the latest version from the [releases](https://github.com/Splode/pomotroid/releases) page.

Pomotroid is available for Windows, Mac OSX and Linux.
Expand All @@ -51,7 +73,6 @@ scoop install https://raw.githubusercontent.com/Splode/pomotroid/master/pomotroi
:memo: Future plans for enhancements and development:

- Mini-mode
- Themes

## Development

Expand Down
Binary file added docs/themes/images/andromeda_01.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/themes/images/andromeda_02.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/themes/images/ayu_01.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/themes/images/ayu_02.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/themes/images/city-lights_01.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/themes/images/city-lights_02.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/themes/images/dracula_01.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/themes/images/dracula_02.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/themes/images/dva_01.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/themes/images/dva_02.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/themes/images/github_01.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/themes/images/github_02.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/themes/images/graphite_01.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/themes/images/graphite_02.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/themes/images/gruvbox_01.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/themes/images/gruvbox_02.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/themes/images/monokai_01.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/themes/images/monokai_02.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/themes/images/nord_01.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/themes/images/nord_02.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/themes/images/one-dark-pro_01.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/themes/images/one-dark-pro_02.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/themes/images/pomotroid_01.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/themes/images/pomotroid_02.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/themes/images/popping-and-locking_01.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/themes/images/popping-and-locking_02.png
Binary file added docs/themes/images/solarized-light_01.png
Binary file added docs/themes/images/solarized-light_02.png
Binary file added docs/themes/images/spandex_01.png
Binary file added docs/themes/images/spandex_02.png
Binary file added docs/themes/images/synthwave_01.png
Binary file added docs/themes/images/synthwave_02.png
Binary file added docs/themes/images/tokyo-night-storm_01.png
Binary file added docs/themes/images/tokyo-night-storm_02.png
15 changes: 15 additions & 0 deletions docs/themes/theme-template.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
{
"name": "Theme Name",
"colors": {
"--color-long-round": "",
"--color-short-round": "",
"--color-focus-round": "",
"--color-background": "",
"--color-background-light": "",
"--color-background-lightest": "",
"--color-foreground": "",
"--color-foreground-darker": "",
"--color-foreground-darkest": "",
"--color-accent": ""
}
}
60 changes: 60 additions & 0 deletions docs/themes/themes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
# Pomotroid Themes

- [Pomotroid Themes](#pomotroid-themes)
- [Available Themes](#available-themes)
- [Creating a Custom Theme](#creating-a-custom-theme)

## Available Themes

| Theme | Main App | Timer Colors |
| ------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- |
| Andromeda | ![Andromeda theme preview](images/andromeda_01.png) | ![Andromeda theme preview](images/andromeda_02.png) |
| Ayu Mirage | ![Ayu Mirage theme preview](images/ayu_01.png) | ![Ayu Mirage theme preview](images/ayu_02.png) |
| City Lights | ![City Lights theme preview](images/city-lights_01.png) | ![City Lights theme preview](images/city-lights_02.png) |
| Dracula | ![Dracula theme preview](images/dracula_01.png) | ![Dracula theme preview](images/dracula_02.png) |
| D.Va | ![D.Va theme preview](images/dva_01.png) | ![D.Va theme preview](images/dva_02.png) |
| GitHub | ![GitHub theme preview](images/github_01.png) | ![GitHub theme preview](images/github_02.png) |
| Graphite | ![Graphite theme preview](images/graphite_01.png) | ![Graphite theme preview](images/graphite_02.png) |
| Gruvbox | ![Gruvbox theme preview](images/gruvbox_01.png) | ![Gruvbox theme preview](images/gruvbox_02.png) |
| Monokai | ![Monokai theme preview](images/monokai_01.png) | ![Monokai theme preview](images/monokai_02.png) |
| Nord | ![Nord theme preview](images/nord_01.png) | ![Nord theme preview](images/nord_02.png) |
| One Dark Pro | ![One Dark Pro theme preview](images/one-dark-pro_01.png) | ![One Dark Pro theme preview](images/one-dark-pro_02.png) |
| Pomotroid (default) | ![Pomotroid theme preview](images/pomotroid_01.png) | ![Pomotroid theme preview](images/pomotroid_02.png) |
| Popping and Locking | ![Popping and Locking theme preview](images/popping-and-locking_01.png) | ![Popping and Locking theme preview](images/popping-and-locking_02.png) |
| Solarized Light | ![Solarized Light theme preview](images/solarized-light_01.png) | ![Solarized Light theme preview](images/solarized-light_02.png) |
| Spandex | ![Spandex theme preview](images/spandex_01.png) | ![Spandex theme preview](images/spandex_02.png) |
| Sythwave | ![Sythwave theme preview](images/synthwave_01.png) | ![Sythwave theme preview](images/synthwave_02.png) |
| Tokyo Night Storm | ![Tokyo Night Storm theme preview](images/tokyo-night-storm_01.png) | ![Tokyo Night Storm theme preview](images/tokyo-night-storm_02.png) |

## Creating a Custom Theme

Creating custom themes is simple. Themes are defined by a `json` file containing a **theme name** and several color values. Use the [theme template file](./theme-template.json) as a starting point.

```json
// theme-template.json
{
"name": "Theme Name",
"colors": {
"--color-long-round": "",
"--color-short-round": "",
"--color-focus-round": "",
"--color-background": "",
"--color-background-light": "",
"--color-background-lightest": "",
"--color-foreground": "",
"--color-foreground-darker": "",
"--color-foreground-darkest": "",
"--color-accent": ""
}
}
```

To add your custom theme, copy your theme definition to the `themes` directory in the `appData` directory. The location of the `appData` depends on the operating system.

- `%APPDATA%` on **Windows**
- `$XDG_CONFIG_HOME` or `~/.config` on **Linux**
- `~/Library/Application Support` on **macOS**

Copy your theme definition to the `themes` directory. For example, add the theme to the following directory on Windows: `C:\Users\{User}\AppData\Roaming\pomotroid\themes`

Restart the application, and you should see your new theme available as an option.

0 comments on commit 67109a1

Please sign in to comment.