Commits

Ragnara committed 090d687

readme.rst changed

Comments (0)

Files changed (1)

 buildcounter
 ------------
 
-buildcounter is a small (ISC-licensed) tool that helps keeping track of different builds for projects in C/C++. It works by creating and modifying a header file that contains a define like this:
+buildcounter is a small automatic (and ISC-licensed) tool that helps keeping track of different builds for projects in C/C++. It can be used in makefiles or as part of any project that supports custom post-build steps (like Visual Studio). It works by creating and modifying a header file that contains a define like this:
 
 ``#define BUILDNO 17``
 
 
 ``buildcounter buildno.h``
 
-I recommend to do it after successful linking so that only successful builds increase the build count. Otherwise, fixing compile errors with many failed attempts lead to jumps in the build count.
+I recommend to do it after successful linking so that only successful builds increase the build count. Otherwise, fixing compile errors with many failed attempts lead to jumps in the build count. You can take a look at the makefile for this project to see how I use it.
 
 Also run it once manually to make sure that buildno.h exists and contains the define. Include the buildno.h and use the define to output your build number.
 
 \-\-
     Use this parameter to use one of the other parameter names as the output filename (do you really want that?)
 
+Do *not* change the contents of the output file manually. buildcounter will not overwrite files that do not begin with the expected ``#define BUILDNO <any number>\n`` and any changes after that line will be overwritten.
+
 License
 .......