nakamochi
/
ndg
Archived
2
0
Fork 0
Code Issues Pull Requests Projects Releases 14 Activity
This repository has been archived on 2024-05-29. You can view files and clone it, but cannot push or open issues/pull-requests.
16 Commits
2 Branches
14 Tags
32 MiB
C 98.7%
Python 0.6%
Zig 0.5%
C++ 0.1%
 
 
 
 
Go to file
alex ae7c3b2db8
tools: be silent when checking c code formatting 
no news is good news. and either way, clang-format verbose mode is
inconsistent with zig fmt. the latter outputs only malformatted files.
 		2023-02-08 16:17:19 +01:00
doc start: initial minimal implementation 2022-09-30 15:01:08 +02:00
lib src,lib: zig fmt and clang-format all code 2023-02-05 16:07:21 +01:00
src ui/c: workaround clang-format's pointer alignment in a define 2023-02-08 16:13:44 +01:00
tools tools: be silent when checking c code formatting 2023-02-08 16:17:19 +01:00
.clang-format src,lib: zig fmt and clang-format all code 2023-02-05 16:07:21 +01:00
.git-blame-ignore-revs git: add 2ecd44a7 to blame-ignore list 2023-02-08 16:16:34 +01:00
.gitignore repo: initial blank import of zig init-exe 2022-09-12 13:42:44 +02:00
LICENSE license: add qeles AG to copyright holders 2023-01-31 15:15:12 +01:00
README.md docs: a quick local dev setup and contributing sections 2023-02-05 16:13:52 +01:00
build.zig zig: switch from stage1 to the new stage2 compiler 2023-02-08 15:57:57 +01:00

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

see also the contributing section.

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.