From 43371051dea288fd18a9696828956354e3cfd6fc Mon Sep 17 00:00:00 2001 From: SiddhiPandey08 Date: Tue, 19 Aug 2025 19:06:40 +0530 Subject: [PATCH] docs: update Getting Started section --- README.md | 35 +++++++++++++++++++++++++---------- 1 file changed, 25 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 929546c9..3416bdae 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,31 @@ -# [Rustlings](https://rustlings.rust-lang.org) 🦀 +# Rustlings 🦀 -Small exercises to get you used to reading and writing [Rust](https://www.rust-lang.org) code - _Recommended in parallel to reading [the official Rust book](https://doc.rust-lang.org/book) 📚️_ +[![Rust](https://img.shields.io/badge/Rust-🦀-orange?style=flat&logo=rust)](https://www.rust-lang.org) +[![Build Status](https://img.shields.io/github/actions/workflow/status/rust-lang/rustlings/ci.yml?branch=main&label=build)](https://github.com/rust-lang/rustlings/actions) +[![License](https://img.shields.io/github/license/rust-lang/rustlings)](LICENSE) -Visit the **website** for a demo, info about setup and more: +Learn [Rust](https://www.rust-lang.org) through small exercises that get you used to reading and writing code. +📖 Recommended alongside [The Rust Programming Language book](https://doc.rust-lang.org/book). -## ➡️ [rustlings.rust-lang.org](https://rustlings.rust-lang.org) ⬅️ +👉 Visit the website for more info, setup guides, and a demo: +**[rustlings.rust-lang.org](https://rustlings.rust-lang.org)** -## Getting Started +--- -To get started with Rustlings: +## Getting Started -1. Make sure you have [Rust](https://www.rust-lang.org/tools/install) installed. - ```bash - rustc --version - ``` +Run these commands to get started with Rustlings: + +```bash +# 1. Verify Rust is installed +rustc --version + +# 2. Clone the repository +git clone https://github.com/rust-lang/rustlings.git +cd rustlings + +# 3. Install Rustlings +cargo install --path . + +# 4. Start Rustlings +rustlings watch