Welcome to the advent-of-code-rust-template. This is a Rust template designed to simplify your experience with Advent of Code. It helps you automatically download inputs, supports multiple years of projects, includes benchmarking tools, and features a well-organized workspace architecture. Whether you're a beginner or looking to streamline your coding experience, this template has you covered.
To get started with this template, follow the steps below. You will be able to download and run the project in no time.
- Automatic Input Downloading: Download input data effortlessly for your Advent of Code challenges.
- Multi-Year Support: Easily manage projects from different years.
- Benchmarking Tools: Test the performance of your solutions.
- Clean Workspace Layout: Navigate your projects with ease thanks to an organized structure.
Before you can run the template, ensure your computer meets these requirements:
- Operating System: Windows, MacOS, or Linux
- Rust: Version 1.50 or newer
- Cargo: Comes with Rust installation
- Space: At least 100 MB of free disk space for the template and dependencies
To download the latest version, visit this page: Download Latest Release.
- Click the link above to go to the Releases page.
- Find the latest version listed.
- Choose the file appropriate for your operating system. Files are typically labeled for easy identification.
- Download the file to your computer.
- Once the download is complete, locate the file in your downloads folder.
After downloading, you’ll need to run a few commands to set up the project.
- Open a terminal (Command Prompt for Windows, Terminal for MacOS/Linux).
- Navigate to the folder where you downloaded the template. You can use the
cdcommand to change directories.- For example:
cd Downloads.
- For example:
- Unzip the downloaded file if it’s in a compressed format.
- Change into the unzipped directory with the command:
cd advent-of-code-rust-template - To run the project, use:
cargo run
This will compile and run the Rust program for you.
Now you're ready to use the template for your Advent of Code projects!
-
Create a New Project: To create a new project using this template, run:
cargo new [your_project_name] --binReplace
[your_project_name]with your desired project name. -
Download Input for the Current Challenge: You will find a provided command to automatically fetch today’s challenge input:
cargo run -- fetch input -
Run Your Code: Compile and run your project with:
cargo run -
Benchmark Solutions: If you want to benchmark your code, you can set up tests and use the built-in benchmarking tools:
cargo bench
If you run into issues, here are some common problems and their solutions:
-
Rust Not Installed: Ensure Rust and Cargo are properly installed. You can install Rust from the official website rust-lang.org.
-
Permission Issues: If you face permission errors while downloading or running, try running your terminal as an administrator or changing your folder permissions.
-
Missing Dependencies: Make sure all project dependencies are installed. You can check and install them using:
cargo build
If you require further assistance or have questions, check the following resources:
- GitHub Issues: Visit the issues page of this repository for bug reports or feature requests.
- Rust Documentation: The official Rust documentation is a great resource for learning how to use Rust.
- Community Forum: Join the Rust community on users.rust-lang.org for friendly support.
Explore more about Advent of Code and Rust with these links:
Feel free to bookmark this page for future reference. Happy coding!