Skip to content

Commit

Permalink
Merge pull request #11 from soumyasen1809/tasks
Browse files Browse the repository at this point in the history
Updated README file
  • Loading branch information
soumyasen1809 authored Aug 15, 2024
2 parents b3745e7 + 6d14b01 commit a947e1d
Showing 1 changed file with 30 additions and 3 deletions.
33 changes: 30 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit a947e1d

Please sign in to comment.