Skip to content

Beautify Repo and create "AoC" library #6

@ZeroKnight

Description

@ZeroKnight

Structure and Information

See repositories at the bottom for nice examples.

  • Different languages should be in separate and self-contained directories, possibly at the root of each Day directory at the root of each year directory.
  • Language-agnostic data should go in the root of each year directory, accessible by all languages, such as puzzle inputs and descriptions
  • README at the root of the repository giving an overview of the project and various statistics/information. See Need a README #7
  • README at the root of each Day with any relevant information or notes about the Day/implementation
  • LICENSE file?

Running

The repository should be interacted with via a "suite" of sorts, that launches solutions for any/all days/parts, for a specific language. Practically identical to willkill's repo, but with the ability to select language.

AoC Library

One for each language, used for each day's solutions. Should include the following:

  • Break up problems by part
  • Argument handling; being able to specify which part (and/or day?) to return a solution for
  • The "standard AoC library" portion should include common utility functions/structs/etc not included with the language standard library, as well as anything used in multiple puzzles (eg. tree-search, assembunny, etc).
    • min(), max(), clamp()
  • Optional visualization related members to run an animation (exclusively or after the main output).

Examples

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions