|
2 years ago | |
---|---|---|
doc | 2 years ago | |
lib | 2 years ago | |
src | 2 years ago | |
tools | 2 years ago | |
.clang-format | 2 years ago | |
.git-blame-ignore-revs | 2 years ago | |
.gitignore | 2 years ago | |
LICENSE | 2 years ago | |
README.md | 2 years ago | |
build.zig | 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
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.