Sane build system conventions, a collection of helpers and an opinionated implementation of a C/C++ build system on top of rake
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
doc
gem
lib
test
.coveralls.yml
.gitattributes
.gitignore
.travis.yml
Gemfile
History.txt
README.md
Rakefile

README.md

Gaudi - A Builder Build Status Coverage Status Code Climate doc status

gaudi is not a gem, or a library. It is an approach to constructing build systems for highly complex projects that incorporate multiple technologies, languages and tools.

Goals

The main goals for Gaudi are:

  • Provide a simple, centralized way for configuring a development environment beginning with the build process
  • Codify a set of conventions for projects targeting multiple platforms.
  • Form the basis for a consistent CLI interface between the developers and the development environment

The approach is layed out in more detail in the documentation

Getting started

This repository hosts the core gaudi code and gaudi-c, the C/C++ building module.

Gaudi is meant to be a part of you code repository from the initial commit. To that purpose there is a gaudi gem that simplifies the process of integrating gaudi and repo.

Install the gaudi gem:

gem install gaudi

Create the project scaffold:

gaudi -s gaudi_project

This will create a basic project structure and pull the current version of gaudi from the repo. The scaffold also adds the correct files and structure to support features like the documentaiton tasks

Add the gaudi-c module:

gaudi -l gaudi-c https://github.com/damphyr/gaudi.git gaudi_project

Gaudi?

Well, if you know who Gaudi was you should concentrate on the fact that he rarely produced detailed plans of his works, he created models.

Gaudi was very much a builder and a craftsman, each of his buildings unique yet based on his knowledge of the materials and the techniques for working with them.

LICENSE:

(The MIT License)

Copyright (c) 2013-2018 Vassilis Rizopoulos

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.