mirror of https://github.com/nakamochi/ndg

You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

This repo is archived. You can view files and clone it, but cannot push or open issues/pull-requests.

Go to file

alex 8426bb046b ngui: port some LVGL-based UI code from C to zig this commit includes lots of new code in ui/lvgl.zig and ui/widget.zig to work with LVGL directly from zig. in fact, some C code is moved from ui/c/ui.c to ui/xxx.zig. in addition, a new module ui/widget.zig is where all custom UI elements will reside. at the moment it comprises of the ported topdrop and a new modal func. the latter is an alternative to LVGL's lv_msgbox popup. as a practical example, the commit replaces the power off confirmation popup with the new modal window.		2 years ago
doc	start: initial minimal implementation	2 years ago
lib	src,lib: zig fmt and clang-format all code	2 years ago
src	ngui: port some LVGL-based UI code from C to zig	2 years ago
tools	ci: run lint, tests and build for each commit	2 years ago
.clang-format	ngui: port some LVGL-based UI code from C to zig	2 years ago
.git-blame-ignore-revs	git: add `2ecd44a7` to blame-ignore list	2 years ago
.gitignore	repo: initial blank import of zig init-exe	2 years ago
.woodpecker.yml	ci: run lint, tests and build for each commit	2 years ago
LICENSE	license: add qeles AG to copyright holders	2 years ago
README.md	ci: run lint, tests and build for each commit	2 years ago
build.zig	ngui: get rid of the ambiguous ui header file	2 years ago

README.md

nakamochi daemon and gui (ndg)

build for rpi:

zig build -Dtarget=aarch64-linux-musl -Ddriver=fbev -Drelease-safe -Dstrip

otherwise just zig build on dev host

local development

you'll need zig v0.10.x. if working on the gui, also SDL2.

note that compiling the daemon on macOS is currently unsupported since it requires some linux primitives.

compiling is expected to be as easy as

# only gui
zig build ngui
# only daemon
zig build nd
# everything at once
zig build

the output is placed in ./zig-out/bin directory. for example, to run the gui, simply execute ./zig-out/bin/ngui.

run all tests with

zig build test

or a filtered subset using test-filter:

zig build test -Dtest-filter=xxx

significant contributors may find adding .git-blame-ignore-revs file to their git config useful, to skip very likely irrelevant commits when browsing git blame:

git config blame.ignoreRevsFile .git-blame-ignore-revs

CI automated checks

the CI runs code format checks, tests and builds for fbdev+evdev on aarch64 and SDL2. it requires a container image with zig and clang tools such as clang-format.

to make a new image and switch the CI to use it, first modify the ci-containerfile and produce the image locally:

podman build --rm -t ndg-ci -f ./tools/ci-containerfile \
  --build-arg ZIGURL=https://ziglang.org/download/0.10.1/zig-linux-x86_64-0.10.1.tar.xz

then tag it with the target URL, for example:

podman tag localhost/ndg-ci git.qcode.ch/nakamochi/ci-zig0.10.1:v1

generate an access token, login to the container registry and push the image to remote:

podman login git.qcode.ch
podman push git.qcode.ch/nakamochi/ci-zig0.10.1:v1

the image will be available at https://git.qcode.ch/nakamochi/-/packages/

finally, delete the access token from https://git.qcode.ch/user/settings/applications

what's left is to update the CI build pipeline and delete the older version of the image.

contributing

to contribute, create a pull request or send a patch with git send-mail to alex-dot-cloudware.io.

before sending a change, please make sure tests pass:

zig build test

and all code is formatted: zig code with zig fmt and C according to the style described by .clang-format file. if clang-format tool is installed, all formatting can be checked with:

./tools/fmt-check.sh

note that only C files in src/ are formatted. leave third party libraries as is - it is easier to update and upgrade when the original style is preserved, even if it doesn't match this project.