Skip to content

Commit

Permalink
Added more information to README
Browse files Browse the repository at this point in the history
  • Loading branch information
miguelfranca committed Sep 3, 2022
1 parent 20e94e0 commit d3bf91b
Showing 1 changed file with 38 additions and 3 deletions.
41 changes: 38 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,38 @@
![](generated/walk_around.gif)
![](generated/color_map_BH_400_resolution.png)
![](generated/color_map_einstein_ring_BH.png)

# Black Hole Raytracer



## Authors

- [@Tiago França](https://github.com/TaigoFr)
- [@Miguel França](https://github.com/MykeFr)


## Installation

1 - Run `apt-get install libomp-dev` to install OpenMP

2 - Download the SFML SDK from: https://www.sfml-dev.org/download/sfml/2.5.1/,
unpack it and copy the files to your preferred location

3 - Create the following environment variable:

```bash
SFML_ROOT="<path-to-SFML-folder>"
```

## Running

To run simply execute the following command

```bash
run
```


## Screenshots/GIFs

![](https://github.com/MykeFr/BHRaytracer/blob/main/generated/color_map_BH_400_resolution.png?raw=true)
![](https://github.com/MykeFr/BHRaytracer/blob/main/generated/walk_around.gif?raw=true)
![](https://github.com/MykeFr/BHRaytracer/blob/main/generated/color_map_einstein_ring_BH.png?raw=true)

0 comments on commit d3bf91b

Please sign in to comment.