https://github.com/vincentbernat/bootstrap.c

Boilerplate for small C projects (autotools)
https://github.com/vincentbernat/bootstrap.c

Last synced: 11 days ago
JSON representation

Boilerplate for small C projects (autotools)

• Host: GitHub
• URL: https://github.com/vincentbernat/bootstrap.c
• Owner: vincentbernat
• Created: 2013-02-07T21:34:54.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2022-12-15T09:06:26.000Z (over 1 year ago)
• Last Synced: 2024-05-09T10:14:57.679Z (about 2 months ago)
• Language: C
• Homepage: http://vincent.bernat.im/en/blog/2013-bootstrap.c.html
• Size: 47.9 KB
• Stars: 76
• Watchers: 9
• Forks: 5
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Lists

• awesome-stars - bootstrap.c - Boilerplate for small C projects (autotools) (C)
• awesome-stars - vincentbernat/bootstrap.c - Boilerplate for small C projects (autotools) (C)

README

        
bootstrap.c

===========

`bootstrap.c` is a template for simple projects written in C with

autotools. It is however mostly an experiment. Can it be as useful as

projects like [HTML5 Boilerplate][]?

[HTML5 Boilerplate]: http://html5boilerplate.com/

There is a [more complete alternative][] if you want to get an embedded

web server with exposed REST/WS/SSE endpoints as well as a client-side

JS app.

[more complete alternative]: https://github.com/vincentbernat/bootstrap.c-web

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/vincentbernat/bootstrap.c.git

    cd your-project

    git init

    git add .

    git commit -m "Initial commit"

[cookiecutter]: https://github.com/audreyr/cookiecutter

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.