diff --git a/README.md b/README.md index 00e2e4f..e367d04 100644 --- a/README.md +++ b/README.md @@ -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. @@ -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. @@ -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 diff --git a/docs/themes/images/andromeda_01.png b/docs/themes/images/andromeda_01.png new file mode 100644 index 0000000..df84ef8 Binary files /dev/null and b/docs/themes/images/andromeda_01.png differ diff --git a/docs/themes/images/andromeda_02.png b/docs/themes/images/andromeda_02.png new file mode 100644 index 0000000..88ea15a Binary files /dev/null and b/docs/themes/images/andromeda_02.png differ diff --git a/docs/themes/images/ayu_01.png b/docs/themes/images/ayu_01.png new file mode 100644 index 0000000..3e4c810 Binary files /dev/null and b/docs/themes/images/ayu_01.png differ diff --git a/docs/themes/images/ayu_02.png b/docs/themes/images/ayu_02.png new file mode 100644 index 0000000..2044c1f Binary files /dev/null and b/docs/themes/images/ayu_02.png differ diff --git a/docs/themes/images/city-lights_01.png b/docs/themes/images/city-lights_01.png new file mode 100644 index 0000000..f4b249e Binary files /dev/null and b/docs/themes/images/city-lights_01.png differ diff --git a/docs/themes/images/city-lights_02.png b/docs/themes/images/city-lights_02.png new file mode 100644 index 0000000..3fff28b Binary files /dev/null and b/docs/themes/images/city-lights_02.png differ diff --git a/docs/themes/images/dracula_01.png b/docs/themes/images/dracula_01.png new file mode 100644 index 0000000..fc58ec8 Binary files /dev/null and b/docs/themes/images/dracula_01.png differ diff --git a/docs/themes/images/dracula_02.png b/docs/themes/images/dracula_02.png new file mode 100644 index 0000000..2b5cf1a Binary files /dev/null and b/docs/themes/images/dracula_02.png differ diff --git a/docs/themes/images/dva_01.png b/docs/themes/images/dva_01.png new file mode 100644 index 0000000..18eddb2 Binary files /dev/null and b/docs/themes/images/dva_01.png differ diff --git a/docs/themes/images/dva_02.png b/docs/themes/images/dva_02.png new file mode 100644 index 0000000..7cebd1c Binary files /dev/null and b/docs/themes/images/dva_02.png differ diff --git a/docs/themes/images/github_01.png b/docs/themes/images/github_01.png new file mode 100644 index 0000000..d671525 Binary files /dev/null and b/docs/themes/images/github_01.png differ diff --git a/docs/themes/images/github_02.png b/docs/themes/images/github_02.png new file mode 100644 index 0000000..e971da4 Binary files /dev/null and b/docs/themes/images/github_02.png differ diff --git a/docs/themes/images/graphite_01.png b/docs/themes/images/graphite_01.png new file mode 100644 index 0000000..b915ee0 Binary files /dev/null and b/docs/themes/images/graphite_01.png differ diff --git a/docs/themes/images/graphite_02.png b/docs/themes/images/graphite_02.png new file mode 100644 index 0000000..ffd827d Binary files /dev/null and b/docs/themes/images/graphite_02.png differ diff --git a/docs/themes/images/gruvbox_01.png b/docs/themes/images/gruvbox_01.png new file mode 100644 index 0000000..c40da7f Binary files /dev/null and b/docs/themes/images/gruvbox_01.png differ diff --git a/docs/themes/images/gruvbox_02.png b/docs/themes/images/gruvbox_02.png new file mode 100644 index 0000000..bf0d30d Binary files /dev/null and b/docs/themes/images/gruvbox_02.png differ diff --git a/docs/themes/images/monokai_01.png b/docs/themes/images/monokai_01.png new file mode 100644 index 0000000..f7db5ab Binary files /dev/null and b/docs/themes/images/monokai_01.png differ diff --git a/docs/themes/images/monokai_02.png b/docs/themes/images/monokai_02.png new file mode 100644 index 0000000..aad5c73 Binary files /dev/null and b/docs/themes/images/monokai_02.png differ diff --git a/docs/themes/images/nord_01.png b/docs/themes/images/nord_01.png new file mode 100644 index 0000000..f7a05ea Binary files /dev/null and b/docs/themes/images/nord_01.png differ diff --git a/docs/themes/images/nord_02.png b/docs/themes/images/nord_02.png new file mode 100644 index 0000000..65722ac Binary files /dev/null and b/docs/themes/images/nord_02.png differ diff --git a/docs/themes/images/one-dark-pro_01.png b/docs/themes/images/one-dark-pro_01.png new file mode 100644 index 0000000..dfd0652 Binary files /dev/null and b/docs/themes/images/one-dark-pro_01.png differ diff --git a/docs/themes/images/one-dark-pro_02.png b/docs/themes/images/one-dark-pro_02.png new file mode 100644 index 0000000..4065263 Binary files /dev/null and b/docs/themes/images/one-dark-pro_02.png differ diff --git a/docs/themes/images/pomotroid_01.png b/docs/themes/images/pomotroid_01.png new file mode 100644 index 0000000..f2dda37 Binary files /dev/null and b/docs/themes/images/pomotroid_01.png differ diff --git a/docs/themes/images/pomotroid_02.png b/docs/themes/images/pomotroid_02.png new file mode 100644 index 0000000..2632f38 Binary files /dev/null and b/docs/themes/images/pomotroid_02.png differ diff --git a/docs/themes/images/popping-and-locking_01.png b/docs/themes/images/popping-and-locking_01.png new file mode 100644 index 0000000..90a8476 Binary files /dev/null and b/docs/themes/images/popping-and-locking_01.png differ diff --git a/docs/themes/images/popping-and-locking_02.png b/docs/themes/images/popping-and-locking_02.png new file mode 100644 index 0000000..b19ec9a Binary files /dev/null and b/docs/themes/images/popping-and-locking_02.png differ diff --git a/docs/themes/images/solarized-light_01.png b/docs/themes/images/solarized-light_01.png new file mode 100644 index 0000000..6ae433b Binary files /dev/null and b/docs/themes/images/solarized-light_01.png differ diff --git a/docs/themes/images/solarized-light_02.png b/docs/themes/images/solarized-light_02.png new file mode 100644 index 0000000..fe8b678 Binary files /dev/null and b/docs/themes/images/solarized-light_02.png differ diff --git a/docs/themes/images/spandex_01.png b/docs/themes/images/spandex_01.png new file mode 100644 index 0000000..a187739 Binary files /dev/null and b/docs/themes/images/spandex_01.png differ diff --git a/docs/themes/images/spandex_02.png b/docs/themes/images/spandex_02.png new file mode 100644 index 0000000..3bd2635 Binary files /dev/null and b/docs/themes/images/spandex_02.png differ diff --git a/docs/themes/images/synthwave_01.png b/docs/themes/images/synthwave_01.png new file mode 100644 index 0000000..030ab2f Binary files /dev/null and b/docs/themes/images/synthwave_01.png differ diff --git a/docs/themes/images/synthwave_02.png b/docs/themes/images/synthwave_02.png new file mode 100644 index 0000000..4a1f1e6 Binary files /dev/null and b/docs/themes/images/synthwave_02.png differ diff --git a/docs/themes/images/tokyo-night-storm_01.png b/docs/themes/images/tokyo-night-storm_01.png new file mode 100644 index 0000000..b43ecf2 Binary files /dev/null and b/docs/themes/images/tokyo-night-storm_01.png differ diff --git a/docs/themes/images/tokyo-night-storm_02.png b/docs/themes/images/tokyo-night-storm_02.png new file mode 100644 index 0000000..4e73868 Binary files /dev/null and b/docs/themes/images/tokyo-night-storm_02.png differ diff --git a/docs/themes/theme-template.json b/docs/themes/theme-template.json new file mode 100644 index 0000000..f3a8127 --- /dev/null +++ b/docs/themes/theme-template.json @@ -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": "" + } +} diff --git a/docs/themes/themes.md b/docs/themes/themes.md new file mode 100644 index 0000000..680e34f --- /dev/null +++ b/docs/themes/themes.md @@ -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.