https://github.com/nitrogenez/gaffer

A project manager for modern C++
https://github.com/nitrogenez/gaffer

cpp cpp-programming cpp23 dependency-manager modern-cpp project-management

Last synced: about 2 months ago
JSON representation

A project manager for modern C++

• Host: GitHub
• URL: https://github.com/nitrogenez/gaffer
• Owner: nitrogenez
• License: bsd-3-clause
• Created: 2023-08-02T19:57:48.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-08-10T21:30:27.000Z (over 1 year ago)
• Last Synced: 2024-11-01T10:21:51.662Z (3 months ago)
• Topics: cpp, cpp-programming, cpp23, dependency-manager, modern-cpp, project-management
• Language: C++
• Homepage:
• Size: 148 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        


Gaffer: A project manager for modern C++


![Build](https://img.shields.io/github/actions/workflow/status/nitrogenez/gaffer/CI.yaml?style=flat-square&logo=github&labelColor=1a0026&color=cc51ff)

![Commits](https://img.shields.io/github/commit-activity/m/nitrogenez/gaffer?style=flat-square&logo=github&label=Commits%2Fmonth&labelColor=1a0026&color=cc51ff)

![License](https://img.shields.io/github/license/nitrogenez/gaffer?style=flat-square&color=cc51ff&labelColor=1a0026&label=Licensed%20under)

![Forks](https://img.shields.io/github/forks/nitrogenez/gaffer?label=Fork%20me!&style=flat-square&labelColor=1a0026&color=cc51ff&logo=github)

![GitHub contributors](https://img.shields.io/github/contributors-anon/nitrogenez/gaffer?style=flat-square&logo=github&label=Contributors&labelColor=1a0026&color=cc51ff)

## Description

Gaffer is a project manager for modern C++ heavily inspired by Cargo for the Rust programming language. Gaffer aims to be customizable, fast, pretty, and easy to use.

> **NOTE**  

> Gaffer is currently in alpha and is being actively developed.  

> If you encounter any bugs, and/or have any proposals, please, [raise an issue](https://github.com/nitrogenez/gaffer/issues/new).

## Contributing

If you wish to contribute to Gaffer, there are steps you need to follow:

+ **Step 1**: [Fork the gaffer repository](https://github.com/nitrogenez/gaffer/fork)

+ **Step 2**: Start a new branch, e.g `git checkout -b feature/cool_feature`

+ **Step 3**: Make your changes

+ **Step 4**: Commit your changes, e.g `git commit -m "feature: added cool feature"`

+ **Step 5**: [Open a merge request](https://github.com/nitrogenez/gaffer/compare)

+ **Step 6**: Wait for the Gaffer maintainers to review your request

+ **Step 7**: There's no step seven

## Code styling

There are no any rules on what the code should look like.  

Write it as you feel to be writing. Just use a 4-space identation, and you are GTG.

## Building

Gaffer uses `meson` as a build system, at the moment, so just use two simple commands:

+ `meson setup build`

+ `meson compile -C build`

## License

Gaffer is licensed under **BSD-3-Clause "New" or "Revised" License**. See [LICENSE](LICENSE.md) to know more.