From 1e6f7f4988d8bb9a7d122c1992b46a56f324c249 Mon Sep 17 00:00:00 2001 From: Vatan Aksoy Tezer Date: Sun, 4 Jul 2021 20:56:57 +0300 Subject: [PATCH] Fix badges --- README.md | 20 +++++++++++++++++--- 1 file changed, 17 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index c87d31f..e4a5bcf 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,18 @@ -# robot-2021 +# robot-2021-offseason -[![Formatting (pre-commit)](https://github.com/sneakysnakesfrc/robot-2021-offseason/workflows/format.yaml/badge.svg?branch=main)](https://github.com/sneakysnakesfrc/robot-2021-offseason/workflows/format.yaml?query=branch%3Amain) -[![Build And Test](https://github.com/sneakysnakesfrc/robot-2021-offseason/workflows/build_and_test.yaml/badge.svg?branch=main)](https://github.com/sneakysnakesfrc/robot-2021-offseason/workflows/build_and_test.yaml?query=branch%3Amain) +[![Formatting (pre-commit)](https://github.com/sneakysnakesfrc/robot-2021-offseason/actions/workflows/format.yaml/badge.svg?branch=main)](https://github.com/sneakysnakesfrc/robot-2021-offseason/actions/workflows/format.yaml?query=branch%3Amain) +[![Build And Test](https://github.com/sneakysnakesfrc/robot-2021-offseason/actions/workflows/build_and_test.yaml/badge.svg?branch=main)](https://github.com/sneakysnakesfrc/robot-2021-offseason/actions/workflows/build_and_test.yaml?query=branch%3Amain) + +**Formatting with pre-commit** + +pre-commit is a tool that is used in this repository to check and apply style guidelines automatically. To install pre-commit into your system: + + pip3 install pre-commit + +Then under root directory install the git hooks like this: + + pre-commit install + +With this pre-commit will automatically run and check a list of styling including clang-format, end of files and trailing whitespaces whenever you run `git commit`. To run pre-commit any time other than `git commit`: + + pre-commit run -a