summaryrefslogtreecommitdiff
path: root/README.md
blob: 57826550eab7b0152729bc8d99e83cefc7b97591 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
Copernicus
==========
![Copernicus](https://i.imgur.com/UHR9TMi.png)

A digital homage to the Raketa Kopernik mechanical watch, inspired by the orbits of the sun and the moon, with a few configurable features:

* Dark and light variants

* Enable/disable arbor

* Enable/disable seconds hand

The design is high-contrast and intended to be easily readable with or without the backlight active.

It may be found [on the Garmin store](https://apps.garmin.com/en-US/apps/7f9c1277-ffb8-44f6-ab86-963ad88c85a6).

Building
--------
Follow the Garmin instructions for installing and configuring the SDK, along with Eclipse.  Note the key requirements, etc.  Unfortunately, you cannot, as far as I can tell, build the bundle necessary to submit to the Garmin store without using their Eclipse plugins (also the SDK tools don't seem to run on Ubuntu without fiddling anymore?).  This version builds with the ConnectIQ SDK version `3.0.11`.

After you do a build, you can deploy it locally by just copying the `.prg` file over USB to your watch.

Open Source
-----------
I'm releasing this as open source in the hopes that someone may find it interesting or useful.  The only mildly clever feature in the code is that things drawn on-screen are scaled to the screen size in-code for each device.  This lets the watchface port trivially to all Garmin watches, regardless of shape and pixel count.

This code is covered by the included BSD 3-clause license (see LICENSE file).  Any patches, bug reports, or other user commments are greatly appreciated.  I will note that I personally consider this feature-complete, and am not likely to merge features that make the design more complicated.  Please feel free to fork if you plan on signficant additions.