Skip to content
This repository has been archived by the owner on May 29, 2024. It is now read-only.

Commit

Permalink
[DOCS]: clean doc
Browse files Browse the repository at this point in the history
  • Loading branch information
bobis33 committed Apr 8, 2024
1 parent 960a751 commit 15656a7
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 3 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
# Executables
*.out
raytracer
plugins/*

# CMake
CMakeCache.txt
Expand Down
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,39 +2,42 @@

![Epitech](doc/png/Epitech_banner.png)


## Description

Ray tracing is a technique used to generate realistic digital images by simulating the inverse path of light.
Goal of this project is to create a program able to generate an image from a file describing the scene.


## Prerequisites

- CMake 3.27
- C++20
- libconfig++
- SFML 2.5.1


## Usage


### Build

```bash
$> ./build.sh build
[...]
```

### Launch arcade

### Launch RayTracer

```bash
$> ./raytracer .
[...]
```



## Architecture


```
RayTracer/
Expand All @@ -47,6 +50,7 @@ $> ./raytracer .
└─
```


## Commit Norms

| Commit Type | Description |
Expand All @@ -61,6 +65,7 @@ $> ./raytracer .
| docs | Writing or updating documentation |
| test | Addition or modification of tests |


## Contributors
- [Elliot Masina](https://github.com/bobis33)
- [Jules Sourbets](https://github.com/wwLeji)
Binary file modified doc/RayTracer.pdf
Binary file not shown.

0 comments on commit 15656a7

Please sign in to comment.