From 6d14b01dc1f70708b3a4403faf68eec6cb27476f Mon Sep 17 00:00:00 2001
From: Soumya <soumyasen1809@gmail.com>
Date: Thu, 15 Aug 2024 17:09:56 +0200
Subject: [PATCH] [none] Updated README file

- Updated README file to describe the usage of the repository

% SOFTWARE
---
 README.md | 33 ++++++++++++++++++++++++++++++---
 1 file changed, 30 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index 79ad1fa..636acbb 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,32 @@
 # RustRayTracer
-Ray Tracer written in Rust
 
-eval $(ssh-agent)
-ssh-add ~/.ssh/id_ed25519
+## About
+This is a simple ray-tracer implementation in Rust of [Peter Shirley's "Ray Tracing In One Weekend"](https://raytracing.github.io/books/RayTracingInOneWeekend.html) book. This is the first of the series:
+
+- Ray tracing in one weekend, in Rust
+- [Ray tracing: the next week, in Rust](https://raytracing.github.io/books/RayTracingTheNextWeek.html)
+- [Ray tracing: the rest of your life, in Rust](https://raytracing.github.io/books/RayTracingTheRestOfYourLife.html)
+
+It serves as a learning tool for understanding the basics of ray tracing and the Rust programming language.
+Every commit in the code implements a particular chapter. In this way it's easy to follow the progress in the book.
+
+## Usage
+1. Clone the repository:
+```
+> git clone https://github.com/soumyasen1809/RustRayTracer.git
+> cd RustRayTracer
+```
+
+2. Build the project:
+```
+> cargo build --release
+```
+
+3. Run the ray-tracer:
+```
+> cargo run
+```
+
+## License
+This project is licensed under the GNU GENERAL PUBLIC license. See the LICENSE file for more details.
+