Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Beautify Repo and create "AoC" library #6

Open
ZeroKnight opened this issue Jan 4, 2017 · 0 comments
Open

Beautify Repo and create "AoC" library #6

ZeroKnight opened this issue Jan 4, 2017 · 0 comments

Comments

@ZeroKnight
Copy link
Owner

ZeroKnight commented Jan 4, 2017

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

@ZeroKnight ZeroKnight changed the title Idea for C++ solutions Clean up and "library-ize" the repo Jan 4, 2017
@ZeroKnight ZeroKnight changed the title Clean up and "library-ize" the repo Create AoC library and refactor solutions to use it Jan 4, 2017
@ZeroKnight ZeroKnight changed the title Create AoC library and refactor solutions to use it Beautify Repo and create "AoC" library Feb 1, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant