Add Readme.txt

This commit is contained in:
benn 2025-05-30 16:46:59 +02:00
parent 2d42416a9b
commit 1fd513bd9d

25
Readme.txt Normal file
View file

@ -0,0 +1,25 @@
Generic C++ project for NetBeans.
After cloning this repo, the directory can be loaded into NetBeans.
However, the associated script, nb_create.sh, also here in this repository, can
be used to create a NetBeans project from the command line without having to
start NetBeans. (Try nb_create.sh -h for more details.)
This NetBeans C++ project contains a number of targets:
debug
release
check1
check2
check1 uses the cppcheck static analysis tool, https://cppcheck.sourceforge.io/,
with output to a NetBeans buffer.
See the Makefile to configure flags.
check2 uses clang-tidy to perform static analysis on the project. clang-tidy
requires a compilation database file: compile_commands.json. A default file is
provided. However if, you add files, modify compile flags, ... you must
generate such a file yourself using bear, https://github.com/rizsotto/Bear.git.
To generate yoour own compile_comands.json, do the following from the top-level
project directory:
bear -- make