aten2k / cookiecutter-etna-c

Cookie Cutter template for C/C++ projects

cookiecutter-etna-c

cookiecutter-etna-c is a template for simple projects written in C with autotools.

Usage

You need cookiecutter, a tool to create projects from project templates. Once installed (in a virtualenv or just with pip install cookiecutter), you can use the following command:

cookiecutter https://github.com/aten2k/cookiecutter-etna-c.git
cd your-project
git init
git add .
git commit -m "Initial commit"

Then, use the following command to get the first steps to get started:

git ls-tree -r --name-only HEAD | \
      xargs grep -nH "T[O]DO:" | \
      sed 's/\([^:]*:[^:]*\):\(.*\)T[O]DO:\(.*\)/\3 (\1)/' | \
      sort -ns | \
      awk '(last != $1) {print ""} {last=$1 ; print}'

Once you are done, your project is ready and you can compile it with and get a release tarball with:

sh autogen.sh
mkdir build
cd build
../configure
make
make dist

Once you want to make a release, tag the tree with git tag 1.3, then run the previous commands from the top. You'll get a properly versioned tarball with a ChangeLog file if this is not your first version.

License

cookiecutter-etna-c's Issues

Fix base files

Base files ({{cookiecutter_project_name|lower}}.c and log.c) provide some compile time errors. (PACKAGE, vasprintf...)

bootstrap.c: In function ‘usage’:
bootstrap.c:36:35: error: ‘PACKAGE_STRING’ undeclared (first use in this function)
  fprintf(stderr, "Version: %s\n", PACKAGE_STRING);
                                   ^~~~~~~~~~~~~~
bootstrap.c:36:35: note: each undeclared identifier is reported only once for each function it appears in
bootstrap.c:42:37: error: expected ‘)’ before ‘PACKAGE’
  fprintf(stderr, "see manual page " PACKAGE "(8) for more information\n");
                                     ^~~~~~~
bootstrap.c: In function ‘main’:
bootstrap.c:69:28: error: ‘PACKAGE_VERSION’ undeclared (first use in this function)
    fprintf(stdout, "%s\n", PACKAGE_VERSION);
                            ^~~~~~~~~~~~~~~
log.c: In function ‘vlog’:
log.c:130:7: warning: implicit declaration of function ‘vasprintf’ [-Wimplicit-function-declaration]
   if (vasprintf(&result, fmt, ap) != -1) {
       ^~~~~~~~~
log.c:140:7: warning: implicit declaration of function ‘asprintf’ [-Wimplicit-function-declaration]
   if (asprintf(&nfmt, "%s %s%s%s]%s %s\n",
       ^~~~~~~~