cupcakearmy/unpixel
1
0
Fork 0
mirror of https://github.com/cupcakearmy/unpixel.git synced 2024-12-22 08:06:33 +00:00
Code Issues Packages Projects Releases Wiki Activity
27ec42fecd
unpixel/README.md
cupcakearmy 6e5cb4ef4f
docs
2021-05-15 16:49:05 +02:00

1.4 KiB
Raw Blame History

logo

UnPixel

Help your eyes take a break

screenshot

🤔 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 and here.

💻 Installation

Head to the release page 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. yarn install
  3. yarn dist to build for all platforms

Alternatively you can run yarn build and the yarn 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. Push to main and github workflow will build and upload assets to the draft matching the version of package.json and draft.