From 5cb4b8b1fe1fa968193815f0d2c15d2035b697a4 Mon Sep 17 00:00:00 2001 From: apio Date: Mon, 23 Dec 2024 22:59:57 +0100 Subject: [PATCH] docs: Add clang-format dependency --- docs/dependencies.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/dependencies.md b/docs/dependencies.md index 7ee4bb24..72ff9fbf 100644 --- a/docs/dependencies.md +++ b/docs/dependencies.md @@ -21,6 +21,10 @@ The script provided by the project to run the system, `tools/run.sh`, assumes th That being said, there's no requirement to use QEMU. If you want to use a different virtualization program, such as Oracle VirtualBox or VMWare, just use `tools/build-iso.sh` instead of `run.sh` and use the built `Luna.iso` in those programs. +## Formatting/linting + +Please make sure you have `clang-format` installed. Additionally, if your editor does not support format-on-save or you do not have it configured, please run `tools/run-clang-format.sh` before committing, to make sure all code follows the same style conventions. + ## Source dependencies TLDR: Luna does not depend on any third-party library.