Project and community

Origin

The Hypnos project was started by Albin Söderqvist, with the help of Lukas Berglund, in the spring of 2020 during an internship at Endian Technologies. It began as a fork of najnesnaj's firmware toolkit with the intention of creating a better foundation for a Zephyr-based firmware for the PineTime smartwatch.

Aim

The Hypnos project aims to

1. produce a functional, user-friendly, energy efficient firmware for the PineTime smartwatch
2. distribute all the software, fonts, graphics and documentation under free licenses
3. work closely with the PineTime community and its myriad of development efforts
4. do things the "Zephyr way" and to upstream any improvements
5. keep the code base clean and the build process free of warnings.

Licensing

The software in this repository is under the Apache License 2.0 (the same as the Zephyr project), unless explicitly stated otherwise. Certain dependencies are under the MIT/X11, 3-clause BSD or similar permissive licenses.

The project's documentation -- this wiki and the README -- are under the CC BY-SA 4.0 license.

Blobs do not belong to this project and we recommend using free (as in freedom) debug and programming tools.

How to contribute

Feel free to make a pull request! By doing so you agree to release your contribution under the Apache License 2.0 (or the same license used by the file that you edit). If you submit a new file, then you should add copyright and SPDX lines at the top of the file like this:

/*
 * Copyright (c) 2020 Your name
 *
 * SPDX-License-Identifier: Apache-2.0
 */

If you make any substantial changes to existing source files, then you should also add yourself as co-author in the form of a copyright line.

Please follow the coding style of the Zephyr project. If you use Emacs, then you can add this to your configuration: (setq c-default-style "linux").