sammyenigma/scraps

Useful scraps of C++.

Scraps

Useful scraps of C++ code. This isn't intended for widespread use, and we don't recommend that it be used directly. By open-sourcing it, we aim to...

• Promote transparency.
• Facilitate community involvement regarding issues.
• Publish code with broad application under a permissive enough license that it can be re-used elsewhere.
• Enable open sourcing of other internal projects that depend on Scraps.
• Motivate ourselves to remain conscious of and maintain a higher standard of code quality.

Status

Branch	Status	Description
master		This is the most stable branch, with merges generally coinciding with releases.
develop		This is the most cutting edge branch, which we do day-to-day development in.

Building

Prerequisites

You'll need to install these yourself if you don't have them already.

• The pyyaml and jinja2 Python packages are used by Needy for our dependency configuration.
• git is used to retrieve several of our dependencies.
• pkg-config is used to integrate our dependencies.
• clang and libc++ are required to compile.
• libz is required by Curl.
• OpenGL is required by Scraps.

These things must be installed before continuing.

Configuring

The simplest way to configure is to invoke ./build-deps --configure. This will download all of our third-party dependencies and configure the build to use them. It will also bootstrap b2 if you don't already have it installed (which will be used in the compilation step).

You can override any of our dependencies by placing them in your PKG_CONFIG_PATH before configuring.

Compiling

b2 will compile the library for you. You can also use b2 install --prefix=myinstalldir to install it, along with all of the dependencies that you did not provide during the configure step.

Other platforms

Currently, only 'nix platforms are supported and only with clang and libc++. We have Travis builds for some of these but welcome pull requests for additional platform support. For help in building Scraps on your platform of choice, it may be helpful to explore the scripts/ci directory to determine how we do it.

Issues & Requests

If you discover an issue with security implications, we ask that you first disclose it privately by emailing any of the active BitTorrent contributors.

Feature and pull requests are welcome, but because this library isn't intended for widespread use as a whole, we will not be entertaining requests for new features that don't benefit our other projects.

License

Scraps is provided under the Apache License, which can be found in the LICENSE file.