unpixel/README.md

![logo](./build/github.jpg)

# UnPixel

Help your eyes take a break

![screenshot](./build/screenshot.png)

## 🤔 Why?

When staring for long times at computer screen our eyes can get dry and suffer form what is called Computer Vision Syndrome (CVS).

To combat and alleviate the symptoms there is the famous 20/20/20 rule that aims at reducing the stress on our eyes caused by focusing for long periods on the same distance.

This is not medical advice. Read more [here](https://en.wikipedia.org/wiki/Computer_vision_syndrome) and [here](https://www.aoa.org/healthy-eyes/eye-and-vision-conditions/computer-vision-syndrome).

## 💻 Installation

Head to the [release page](https://github.com/cupcakearmy/unpixel/releases) and grab the latest for your platform.

- For `macOS` you can downlaod the `.dmg` image.
- For `Windows` download the `.exe`.
- For `Linux` either the `.AppImage` or `.deb`, you will know what fits you 😉.

## 🛠 Building / Development

1. Clone the repo
2. `pnpm install`
3. `pnpm dist` to build for all platforms

Alternatively you can run `pnpm build` and the `pnpm electron-builder -m` for `macOS`, `-l` fir `linux` or `-w` for `windows`.

## 📦 Release

1. Bump version in `package.json`
2. Update `CHANGELOG.md`
3. Create a draft release with the new version. (e.g. tag with `v1.2.3`).
4. Start the publish action and the ci will build and upload assets to the draft matching the version of `package.json` and draft.
github readme 2021-04-06 15:39:25 +02:00			`![logo](./build/github.jpg)`

			`# UnPixel`

			`Help your eyes take a break`

			`![screenshot](./build/screenshot.png)`

			`## 🤔 Why?`

			`When staring for long times at computer screen our eyes can get dry and suffer form what is called Computer Vision Syndrome (CVS).`

			`To combat and alleviate the symptoms there is the famous 20/20/20 rule that aims at reducing the stress on our eyes caused by focusing for long periods on the same distance.`

			`This is not medical advice. Read more [here](https://en.wikipedia.org/wiki/Computer_vision_syndrome) and [here](https://www.aoa.org/healthy-eyes/eye-and-vision-conditions/computer-vision-syndrome).`

pause only for limited time 2021-05-15 16:32:12 +02:00			`## 💻 Installation`
github readme 2021-04-06 15:39:25 +02:00
			`Head to the [release page](https://github.com/cupcakearmy/unpixel/releases) and grab the latest for your platform.`
Update README.md 2021-04-07 22:33:12 +02:00
			- For `macOS` you can downlaod the `.dmg` image.
			- For `Windows` download the `.exe`.
			- For `Linux` either the `.AppImage` or `.deb`, you will know what fits you 😉.
version bump and footer 2021-04-07 22:53:28 +02:00
pause only for limited time 2021-05-15 16:32:12 +02:00			`## 🛠 Building / Development`
version bump and footer 2021-04-07 22:53:28 +02:00
			`1. Clone the repo`
pnpm 2022-01-09 19:21:52 +01:00			2. `pnpm install`
			3. `pnpm dist` to build for all platforms
version bump and footer 2021-04-07 22:53:28 +02:00
pnpm 2022-01-09 19:21:52 +01:00			Alternatively you can run `pnpm build` and the `pnpm electron-builder -m` for `macOS`, `-l` fir `linux` or `-w` for `windows`.
macos bug 2021-04-11 16:45:14 +02:00
pause only for limited time 2021-05-15 16:32:12 +02:00			`## 📦 Release`
macos bug 2021-04-11 16:45:14 +02:00
pause only for limited time 2021-05-15 16:32:12 +02:00			1. Bump version in `package.json`
docs 2021-05-15 16:49:05 +02:00			2. Update `CHANGELOG.md`
			3. Create a draft release with the new version. (e.g. tag with `v1.2.3`).
releasing docs 2021-05-15 17:17:44 +02:00			4. Start the publish action and the ci will build and upload assets to the draft matching the version of `package.json` and draft.