Skip to content

Commit 015bd8b

Browse files
committed
Rewrite introduction
1 parent 270ad97 commit 015bd8b

File tree

1 file changed

+4
-8
lines changed

1 file changed

+4
-8
lines changed

README.md

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,12 @@
11
# Advent of Code [![checks-badge]][checks-link] [![docs-badge]][docs-link]
22

3-
Complete 2024 to 2015 entries written in Rust for the annual [Advent of Code] challenge,
4-
solving 500 stars in less than 1 second.
3+
Blazing fast Rust solutions for every [Advent of Code] puzzle from 2015 to 2024, solving 500 stars in **502 milliseconds**. Each solution is meticulously optimized while prioritizing clear, understandable and idiomatic Rust.
54

65
## Features
76

8-
* Each solution uses the most efficient algorithms to the best of my knowledge.
9-
* Self contained depending only on the `std` Rust library. No use of `unsafe` features.
10-
* Consistently formatted with `rustfmt` and linted by `clippy`.
11-
* Thoroughly commented with `rustdoc` generated [documentation online][docs-link].
12-
* Test coverage with continuous integration provided by [GitHub Actions][checks-link].
7+
* **Minimal** - Depends only on the standard library, no external crates.
8+
* **Quality** - No `unsafe` code. Formatted with `rustfmt`, linted by `clippy` and continuously integration tested via [GitHub Actions][checks-link].
9+
* **Well Documented** - Every solution is comprehensively commented and includes detailed explanations with [rustdoc-generated documentation][docs-link] also available online.
1310

1411
## Quickstart
1512

@@ -58,7 +55,6 @@ Improvements to solutions are always appreciated. Please see the
5855
## Performance
5956

6057
Benchmarks are measured using the built-in `cargo bench` tool run on an [Apple M2 Max][apple-link].
61-
All 250 solutions from 2024 to 2015 complete sequentially in **502 milliseconds**.
6258
Interestingly 86% of the total time is spent on just 9 solutions.
6359
Performance is reasonable even on older hardware, for example a 2011 MacBook Pro with an
6460
[Intel i7-2720QM][intel-link] processor takes 3.5 seconds to run the same 250 solutions.

0 commit comments

Comments
 (0)