https://github.com/vector-of-bool/pitchfork
Pitchfork is a Set of C++ Project Conventions
https://github.com/vector-of-bool/pitchfork
Last synced: about 1 year ago
JSON representation
Pitchfork is a Set of C++ Project Conventions
- Host: GitHub
- URL: https://github.com/vector-of-bool/pitchfork
- Owner: vector-of-bool
- License: mit
- Created: 2018-08-24T03:23:06.000Z (almost 8 years ago)
- Default Branch: develop
- Last Pushed: 2024-04-26T09:25:43.000Z (about 2 years ago)
- Last Synced: 2025-04-09T06:08:04.784Z (about 1 year ago)
- Language: C++
- Homepage:
- Size: 286 KB
- Stars: 1,167
- Watchers: 38
- Forks: 57
- Open Issues: 41
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
- awesome-modern-cpp - Pitchfork - Pitchfork is a Set of C++ Project Conventions. (Project Starter Templates / Websites)
- awesome-cmake - pitchfork - A set of conventions for native C and C++ projects. [```[MIT]```][MIT] (Examples / Templates)
README
# Pitchfork
Pitchfork is a set of conventions for native C and C++ projects. The most
prominent being [the project layout conventions](https://api.csswg.org/bikeshed/?force=1&url=https://raw.githubusercontent.com/vector-of-bool/pitchfork/develop/data/spec.bs).
The layout specification document is available in `data/spec.bs`.
## Why the Name *Pitchfork*?
The very first public unveiling, drafting, and discussion of these project
conventions started with [a Reddit thread entitled "Prepare thy Pitchforks"](https://www.reddit.com/r/cpp/comments/996q8o/prepare_thy_pitchforks_a_de_facto_standard/). Until
that point, I had not chosen any particular name for the conventions, but I
felt "Pitchfork" was as apt a name as any.
## The `pf` Tool
This repository also hosts a (currently experimental) tool that helps you
create and work with Pitchfork-compliant projects.
This project is still very young and has a while to go before being a useful
developer tool. Once ready, this README will be updated with proper user
documentation.
## The `pf` Library
The `pf` tool mentioned above is built upon the `pf` library, also hosted in
this repository. This library can be used to query and manipulate
Pitchfork-compliant projects.