Skip to content

Commit bc88ef0

Browse files
committed
docs: Fix README file
1 parent dba8b67 commit bc88ef0

File tree

1 file changed

+29
-14
lines changed

1 file changed

+29
-14
lines changed

β€ŽREADME.md

+29-14
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,45 @@
1-
πŸŽ„ Advent of Code 2024 πŸ¦€
2-
Welcome to the Advent of Code 2024 project! This repository contains my solutions to the Advent of Code challenges, implemented in Rust. Get ready to dive into the holiday spirit with some coding fun! 🎁✨
1+
# πŸŽ„ Advent of Code 2024 πŸ¦€
2+
3+
Welcome to the **Advent of Code 2024** project! This repository contains my solutions to the Advent of Code challenges, implemented in Rust. Get ready to dive into the holiday spirit with some coding fun! 🎁✨
4+
5+
## πŸŽ… Getting Started
36

4-
πŸŽ… Getting Started
57
To run the solutions for a specific day, you'll need to have Rust installed on your machine. If you haven't already, you can install Rust from rust-lang.org.
68

7-
🎁 Running the Solutions
9+
## 🎁 Running the Solutions
10+
811
This project includes a command-line interface to easily run the solution for any day. Simply use the following command:
912

13+
```bash
1014
cargo run <day>
15+
```
16+
1117
Replace <day> with the day number you want to run (e.g., 1 for Day 1). For example:
1218

19+
```bash
1320
cargo run 1
21+
```
22+
1423
This will execute the solutions for Day 1 and display the results for both parts. πŸŽ‰
1524

16-
πŸ“‚ Project Structure
17-
src/: Contains the Rust source files for each day's challenge.
18-
input/: Stores the input files for each day.
19-
Cargo.toml: Manages dependencies and project metadata.
20-
πŸŽ„ Adding New Days
25+
## πŸ“‚ Project Structure
26+
27+
- src/: Contains the Rust source files for each day's challenge.
28+
- input/: Stores the input files for each day.
29+
- Cargo.toml: Manages dependencies and project metadata.
30+
31+
## πŸŽ„ Adding New Days
32+
2133
To add a new day's solution:
2234

23-
Create a new file in the src/ directory named dayXX.rs, where XX is the day number.
24-
Implement the solution functions (solve_part1 and solve_part2) in the new file.
25-
Add the module to main.rs and update the match statement to include the new day.
26-
πŸŽ… Contributing
35+
1. Create a new file in the src/ directory named dayXX.rs, where XX is the day number.
36+
2. Implement the solution functions (solve_part1 and solve_part2) in the new file.
37+
3. Add the module to main.rs and update the match statement to include the new day.
38+
39+
## πŸŽ… Contributing
40+
2741
Feel free to fork this repository and contribute your own solutions or improvements. Let's make this a collaborative and festive coding experience! πŸ€ΆπŸŽ‰
2842

29-
🌟 Happy Coding!
43+
## 🌟 Happy Coding!
44+
3045
May your days be merry and bright and may your code be bug-free! πŸŽ„βœ¨

0 commit comments

Comments
Β (0)