Merge pull request #3 from Alpaca-zip/feature/update_readme

Feature/update readme
Alpaca-zip · Sep 12, 2023 · ec14435 · ec14435
2 parents c0a35b4 + 64ae9b3
commit ec14435
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 6 deletions.
diff --git a/.gitignore b/.gitignore
@@ -52,6 +52,3 @@ CATKIN_IGNORE
 
 # vscode
 .vscode
-
-# compiler logs
-compile_commands.json
diff --git a/README.md b/README.md
@@ -44,9 +44,8 @@ $ sudo apt-get install clang clang-tidy
 ```
 **2. Format with Clang-Tidy**
 ```
-$ catkin build <this_package> --cmake-args -DCMAKE_EXPORT_COMPILE_COMMANDS=1
-$ cp ~/<your_ros_workspace>/build/<this_package>/compile_commands.json <path_of_this_package>/
-$ roscd <this_package> && clang-tidy ./src/<your_cpp>.cpp -p=./ -fix
+$ cd <path_to_your_workspace> && catkin build <this_package> --cmake-args -DCMAKE_EXPORT_COMPILE_COMMANDS=1
+$ clang-tidy -p build/<this_package>/ <path_to_this_package>/src/<your_cpp> -fix
 ```
   Recommended tool : [catkin_tidy](https://github.com/nyxrobotics/catkin_tidy)
 ### Black