Advent of Code Template

A template repository for repos containing solutions to the yearly Advent of Code challenges.

This template is designed for repos where multiple people will be tackling the Advent of Code challenges at the same time. However, this can easily be adapted for a single contributor by simply flattening the "contributor directory" structure shown in the getting started section.

Contents

• Getting Started
• Contributors
• License
  • What This Means For You
    • For Contributors
    • For Users

Getting Started

Anyone contributing to this repo should review the CONTRIBUTING.md document before doing so.

Contributors should also follow the following structure for consistency:

AoC                    # Repository root.
 ├─ .gitignore         # Repository root .gitignore file.
 ├─ CONTRIBUTING.md    # Contribution guidelines.
 ├─ LICENSE            # Repository license.
 ├─ README.md          # Main README (You are here!).
 └─ nat/               # Example contributor's directory.
     ├─ README.md      # Example contributor's README.
     ├─ .gitignore     # Example contributor's .gitignore file.
     └─ day01/         # Example directory for contributor's day 1 challenge.

Tip

After creating your contributor directory, make sure you add your main README.md to the contributors section!

Contributors

Here you can get links to the READMEs within everyone's directory.

Tip

Remove the example contributor directory after consuming this template!

• Nat

License

By contributing to this repository, you agree that all contributions are licensed under the GNU Affero General Public License v3.0. Please review the LICENSE for the full terms and license text.

SPDX-License-Identifier: AGPL-3.0-only

What This Means For You

For Contributors

• Your code will remain open source and must be shared under the same AGPL-3.0 license.
• Any changes or additions you make must also be licensed under AGPL-3.0.

For Users

• AGPL-3.0-only is a copyleft license; you are free to use, modify, and share this code, but any derivative work or modified version must also be licensed under AGPL-3.0.
• If you deploy any of the code publicly, you must make the source code available to users. This includes versions of the code that are accessible to users over a network (including web services and any network-accessible deployment).
• The software is provided “as is”, without any express or implied warranty. See the LICENSE file for details.