From 3cc1ccfed07de266ab5a561d75db7fbddd69c058 Mon Sep 17 00:00:00 2001 From: Miquel Sabaté Solà Date: Wed, 7 May 2025 07:54:27 +0200 Subject: Add a note on .gitattributes MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Miquel Sabaté Solà --- .gitattributes | 1 + README.md | 13 +++++++++++-- 2 files changed, 12 insertions(+), 2 deletions(-) create mode 100644 .gitattributes diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..1a6c279 --- /dev/null +++ b/.gitattributes @@ -0,0 +1 @@ +assets/* linguist-generated diff --git a/README.md b/README.md index a646602..4296eb6 100644 --- a/README.md +++ b/README.md @@ -545,8 +545,17 @@ do not put `.chr` files in the same directory as code or at the root of your project. Moreover, some tools like [NEXXT](https://frankengraphics.itch.io/nexxt) will -save a `session.nss` file to your `assets` directory. Do not remove it nor ignore -it via git, as it will help you everytime you go back to your `chr` files. +save a `session.nss` file to your `assets` directory. Do not remove it nor +ignore it via git, as it will help you everytime you go back to your `chr` +files. + +As a cherry on top, if you want tools to be more accurate on the statistics of +your projects, you might want to to take a look at the given +[.gitattributes](./.gitattributes) file. This file is telling git (and related +porcelain/tools) to consider anything under the `assets/` directory to be +generated. This allows tools like +[linguist](https://github.com/github-linguist/linguist) to perform more accurate +reports. # License -- cgit v1.2.3