Dan Anglin
ec84a11036
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
33 lines
1.3 KiB
Markdown
33 lines
1.3 KiB
Markdown
# 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)
|