pominal/README.md

# Pominal

## Summary

Pominal is a Pomodoro application for the terminal written in Go.
Pominal is primarily written for GNU/Linux but might also run fine on Windows and OSX.

## Installation

Before installing Pominal make sure that you have the tools listed below installed on your system:

- Make
- The latest version of [Go](https://golang.org)

Run the below command to build and install Pominal.
By default Pominal is installed in /usr/local so you may have to run the command with sudo.

```sh
$ make clean install
```

To change the installation path you can edit `INSTALL_PREFIX` in config.mk or set the `INSTALL_PREFIX` variable as you execute `make`:

```sh
# example install Pominal in your home directory
$ INSTALL_PREFIX=${HOME}/.local make clean install
```

If you are installing Pominal on an OS other than GNU/Linux and/or an architecture other than AMD64 then update the `GOOS` and `GOARCH` variables in config.mk.

## Assets

Icon [image](https://pixabay.com/vectors/eat-edible-food-fruit-red-tomato-1299904/) from [OpenClipart-Vectors](https://pixabay.com/users/openclipart-vectors-30363/?utm_source=link-attribution&utm_medium=referral&utm_campaign=image&utm_content=1299904) from [Pixabay](https://pixabay.com/?utm_source=link-attribution&utm_medium=referral&utm_campaign=image&utm_content=1299904)
feat: added Pominal This is the first commit of Pominal, a Pomodoro application for the terminal. This commit includes: - Timers for work sessions, short breaks and long breaks. - Flags to allow users to configure Pominal to their preferences. - Graceful shutdown when a SIGINT or SIGTERM is sent to the application. 2019-05-30 23:19:53 +01:00			`# Pominal`
Initial commit 2019-02-10 23:40:30 +00:00
feat: install Pominal with make This commit adds an install target in the Makefile to install Pominal on the user's system. The default installation path is /usr/local/bin but this can be configured by overriding the INSTALL_PREFIX variable. Changes include: - cleaning up .gitignore - adding workflow to .gitlab-ci.yml - bumping Go version in .gitlab-ci.yml - excluding main.go for gochecknoglobals - adding copyright notice in Makefile - adding install and uninstall targets in Makefile - adding installation instructions in the README - adding a config.mk file for make arguments - updating Pominal to specify where the icon is installed 2020-07-14 19:57:02 +01:00			`## Summary`

			`Pominal is a Pomodoro application for the terminal written in Go.`
			`Pominal is primarily written for GNU/Linux but might also run fine on Windows and OSX.`

			`## Installation`

			`Before installing Pominal make sure that you have the tools listed below installed on your system:`

			`- Make`
			`- The latest version of [Go](https://golang.org)`

			`Run the below command to build and install Pominal.`
			`By default Pominal is installed in /usr/local so you may have to run the command with sudo.`

			```sh
			`$ make clean install`
			```

			To change the installation path you can edit `INSTALL_PREFIX` in config.mk or set the `INSTALL_PREFIX` variable as you execute `make`:

			```sh
			`# example install Pominal in your home directory`
			`$ INSTALL_PREFIX=${HOME}/.local make clean install`
			```

			If you are installing Pominal on an OS other than GNU/Linux and/or an architecture other than AMD64 then update the `GOOS` and `GOARCH` variables in config.mk.
feat: added desktop notification integration 2019-08-16 09:20:56 +01:00
			`## Assets`

			`Icon [image](https://pixabay.com/vectors/eat-edible-food-fruit-red-tomato-1299904/) from [OpenClipart-Vectors](https://pixabay.com/users/openclipart-vectors-30363/?utm_source=link-attribution&utm_medium=referral&utm_campaign=image&utm_content=1299904) from [Pixabay](https://pixabay.com/?utm_source=link-attribution&utm_medium=referral&utm_campaign=image&utm_content=1299904)`