tsmall / advent-of-code

Solutions to the annual Advent of Code

Advent of Code Solutions

This project contains my solutions to the Advent of Code exercises.

Contents

• Project Organization
• Program Design
• Git Hygiene

Project Organization

The project is organized like this:

<root>
  |
  + -- <year>
  |      |
  |      +-- <day>
  |            |
  |            +-- problem.txt
  |            |
  |            +-- input.txt
  |            |
  |            +-- <language>
  |
  +-- lib
       |
       +-- <language>

Program Design

Each program is designed to follow the Unix Philosophy. They are standalone, command-line programs that follow these rules:

• Read input from stdin
• Print output to stdout
• Print error information to stderr
• Print debugging info to stderr if -v or --verbose flag is present

Since the programs take input from stdin, you can use your shell's input redirection or a program like cat to feed them input:

$ cat input.txt | <program>

Git Hygiene

This repository uses a variation of the Conventional Commits format that looks like either this:

<year>/<day>(<scope>): <description>

Or this:

<area>(<scope>): <description>

The scope is either the language of the solution changed (for example stanza) or one of the following:

• docs -- a documentation-only change
• git -- a git admin change