From 2bad01018befbc16e2edb355491e6e1371a8c232 Mon Sep 17 00:00:00 2001 From: Christian Semmler Date: Tue, 12 Dec 2023 11:53:01 -0500 Subject: [PATCH] Update readme --- .github/workflows/naming.yml | 2 +- CONTRIBUTING.md | 8 +------- tools/ncc/{skip.yaml => skip.yml} | 0 3 files changed, 2 insertions(+), 8 deletions(-) rename tools/ncc/{skip.yaml => skip.yml} (100%) diff --git a/.github/workflows/naming.yml b/.github/workflows/naming.yml index cd714133..3daca1ae 100644 --- a/.github/workflows/naming.yml +++ b/.github/workflows/naming.yml @@ -23,7 +23,7 @@ jobs: python3 tools/ncc/ncc.py \ --clang-lib ${{ env.LLVM_PATH }}/lib/libclang.so \ --style tools/ncc/ncc.style \ - --skip tools/ncc/skip.yaml + --skip tools/ncc/skip.yml \ --definition WINAPI FAR HWND__=HWND \ --include util \ --path LEGO1 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0c65bc1c..9fb10839 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -43,13 +43,7 @@ We are currently using [clang-format](https://clang.llvm.org/docs/ClangFormat.ht ### Naming conventions -The following conventions should generally be applied everywhere except for the utility libraries (`LEGO1/realtime`, `LEGO1/tgl`, `LEGO1/viewmanager`) and any 3rd party libraries (`3rdparty`). - -- `PascalCase` for classes, function names, and enumerations. -- `m_camelCase` for member variables. -- `g_camelCase` for global variables. -- `p_camelCase` for function parameters. -- Within the Omni engine (file pattern: `mx*`), instead of C++ primitives (e.g. `int`, `long`, etc.), use types in [`mxtypes.h`](LEGO1/mxtypes.h) instead. This will help us ensure that variables will be the correct size regardless of the underlying compiler/platform/architecture. +We are currently using a customized version of [ncc](https://github.com/nithinn/ncc) with a configuration file that aims to replicate the naming conventions employed by the original developers. `ncc` requires Clang 16; please refer to the [tool](/tools/ncc) and the (GitHub action)[/.github/workflows/naming.yml] for guidance. ## Questions? diff --git a/tools/ncc/skip.yaml b/tools/ncc/skip.yml similarity index 100% rename from tools/ncc/skip.yaml rename to tools/ncc/skip.yml