1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136
//! <p align="center">
//! <a href="https://github.com/hkennyv/aoc/actions?query=workflow%3Agh-pages"><img alt="gh-pages" src="https://img.shields.io/github/workflow/status/hkennyv/aoc/gh-pages?label=gh-pages"></a>
//! <a href="https://github.com/hkennyv/aoc/actions?query=workflow%3ABuild"><img alt="build" src="https://img.shields.io/github/workflow/status/hkennyv/aoc/Build?label=build"></a>
//! <a href="https://github.com/hkennyv/aoc/actions?query=workflow%3ATest"><img alt="test" src="https://img.shields.io/github/workflow/status/hkennyv/aoc/Test?label=test"></a>
//! <a href="https://github.com/hkennyv/aoc/actions?query=workflow%3AFormat"><img alt="format" src="https://img.shields.io/github/workflow/status/hkennyv/aoc/Format?label=format"></a>
//! <a href="https://github.com/hkennyv/aoc/actions?query=workflow%3AClippy"><img alt="clippy" src="https://img.shields.io/github/workflow/status/hkennyv/aoc/Clippy?label=clippy"></a>
//! </p>
//!
//! # Advent of Code
//!
//! **Use the links below to jump to a specific year**
//!
//! - [**AOC**](https://hkennyv.github.io/aoc/aoc/index.html)
//! - [**2019**](https://hkennyv.github.io/aoc/aoc/2019/doc/aoc_2019/index.html)
//! - [**2020**](https://hkennyv.github.io/aoc/aoc/2020/doc/aoc_2020/index.html)
//! - [**2021**](https://hkennyv.github.io/aoc/aoc/2021/doc/aoc_2021/index.html)
//!
//! # Introduction
//!
//! Advent of Code (AOC) is crated by [Eric Wastl](http://was.tl/) and is an
//! annual advent calendar of small programming puzzles. They can be solved
//! in any language (you don't really need code at all to solve some of them)
//! and its intended for people of all skill levels. There are a total of
//! 25 exercises per year, one per day starting on December 1st and ending on
//! December 25th (Christmas).
//!
//! You can find all of the advent of code exercises on the official website
//! here:
//!
//! <https://adventofcode.com/events>
//!
//! # Overview
//!
//! I'm using AOC as an opportunity to sharpen my rust skills and get more
//! familiar with the language and toolchain.
//!
//! This AOC crate serves as a dummy top-level create that links to each of the
//! other years.
//!
//! The repository is structured as follows:
//!
//! - **Each year is a [cargo workspace](https://doc.rust-lang.org/book/ch14-03-cargo-workspaces.html)**
//! - **Each day is a [cargo crate](https://doc.rust-lang.org/book/ch07-01-packages-and-crates.html)**
//!
//! Cheers & happy coding!
//!
//! # How to use
//!
//! There are two ways that you can run the code in this repository:
//!
//! - Run it using [Replit](https://replit.com/)
//! - Run it locally
//!
//! ## Running in replit
//!
//! You can now run all of the examples in this repository without installing any
//! rust toolchains or dependencies directly in the browser here:
//!
//! <https://replit.com/@hkennyv/aoc#README.md>
//!
//! Simply go to the link above, skip the **running locally** section below
//! and go straight to the [**running the code**](#running-the-code) section.
//!
//! ## Running locally
//!
//! In order to run locally, you'll have to install the rust toolchain
//! using rustup. See below.
//!
//! ### Prerequisites
//!
//! - install rust using [rustup](https://www.rust-lang.org/tools/install) (this
//! should install the cargo toolchain as well). using the nightly build is
//! recommended
//!
//! ## Running the code
//!
//! Any day of the AOC can be run by going into that day's directory and running:
//!
//! ```
//! # e.g. if you want to run 2020/day10
//! $ cd 2020/day10
//! $ cargo run --release
//! ```
//!
//! **NOTE:** everyone's input for the advent of code is different. I've committed
//! the input for my account in this repository and the answers for my input in
//! the documentation, however, feel free to run the solutions using your own
//! input. Each crate reads from an "input.txt" file in their respective
//! directories.
//!
//! # Documentation
//!
//! **Bonus:** I've added the description of each day's challenge to the crate
//! description so you can view all of the challenges and all of the
//! functions and their docstrings that I used.
//!
//! To build the documentation for each workspace, simply run the following
//! command in the year's workspace:
//!
//! ```
//! cargo doc --workspace --open
//! ```
//!
//! The documentation should automatically open up in your browser. Each of the
//! AOC days should appear in the left-hand sidebar as its own crate that you can
//! choose to view.
//!
//! ## README
//!
//! **NOTE: this readme is generated using [cargo-readme](https://github.com/livioribeiro/cargo-readme).**
//!
//! To edit the README, please edit the [`src/main.rs`](src/main.rs) file and
//! regenerate the README using the following command:
//!
//! ```
//! cargo readme > README.md
//! ```
//!
//! # Tests
//!
//! Many crates also have some runnable tests that you can run using:
//!
//! ```
//! cargo test
//! ```
//!
//! Alternatively, run tests for the entire workspace using:
//!
//! ```
//! cargo test --all
//! ```
//!
fn main() {
println!("Hello, world!");
}