From 3c3625a71a7b081382390c863f185d99489c8fbb Mon Sep 17 00:00:00 2001 From: Richard Han Date: Sun, 13 Oct 2024 13:28:38 -0700 Subject: [PATCH] add linter instructions --- README.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5063424..60499df 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,8 @@ sudo apt update && sudo apt upgrade -y sudo apt install cmake libssl-dev nghttp2 libopencv-dev libcurl4-openssl-dev -y ``` -Now go to the ArenaSDK download page and download the latest version of the SDK. Extract the contents of the folder and put it into the external directory. +Now go to the ArenaSDK download page and download the latest version of the SDK. +Extract the contents of the folder and put it into the external directory. Follow the README for Arena SDK for Linux to install the SDK. ## Build Instructions @@ -34,6 +35,14 @@ make -j$(nproc) ``` > ***Note:*** Use ``-DCMAKE_BUILD_TYPE=Debug`` for debug information. Use ``-DCMAKE_BUILD_TYPE=Release`` for production. + +## Linter and Formatter +``` +pip install cpplint +clang-format -i src/*.cpp src/*.h +cpplint src/*.cpp src/*.h +``` + ### Python ArenaSDK * Place the ArenaSDK wheel file in `wheel` directory.