Files
prick/README.org

1.7 KiB

┌──────────────────────────────────┐
│  _____  _____  _____ _____ _  __ │
│ |  __ \|  __ \|_   _/ ____| |/ / │
│ | |__) | |__) | | || |    | ' /  │
│ |  ___/|  _  /  | || |    |  <   │
│ | |    | | \ \ _| || |____| . \  │
│ |_|    |_|  \_\_____\_____|_|\_\ │
└──────────────────────────────────┘

A set of libraries that attempt to reduce boilerplate for the programming languages I use. The idea is for each library to be "plug and play", which means complying with the following rules:

  • A library is composed of a single file
  • A library is only dependent on the core utilities provided by the language i.e. they cannot be dependent on each other.
  • A library should be structured to allow easy reading and extraction of functionality if and when required.

These rules allow any library to be near trivial to plug into a project - just copy over the file and utilise it. See below for more details on the libraries provided for each language. Happy coding!

C

The PRICK libraries for C are STB-style header-only libraries. All you need to do is copy the relevant header file for a library over to your project, then setup the implementation code within one (1) code unit:

#define <LIB>_IMPL
#include "./<lib.h>"

See the commentary of the library for specific details regarding this.

Common Lisp

The PRICK libraries for Common Lisp each have a defpackage at the top of the file. You may move this to your packages.lisp if you have one. The implementation is stored within the package, in the same file.