Added README.md
This commit is contained in:
parent
a654eccc41
commit
8d408439b4
25
README.md
Normal file
25
README.md
Normal file
@ -0,0 +1,25 @@
|
|||||||
|
# Raytracer
|
||||||
|
|
||||||
|
Raytracing implementation in Nim, written following the book [The Ray Tracer Challenge: A Test-Driven Guide to Your First 3D Renderer](http://raytracerchallenge.com/)
|
||||||
|
|
||||||
|
## Getting Started
|
||||||
|
|
||||||
|
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
|
||||||
|
|
||||||
|
### Prerequisites
|
||||||
|
|
||||||
|
* [Nim](https://nim-lang.org/)
|
||||||
|
* [Nimble](https://github.com/nim-lang/nimble) *typically bundled as part of a Nim installation
|
||||||
|
* A clone of this repository
|
||||||
|
|
||||||
|
### Building
|
||||||
|
|
||||||
|
```
|
||||||
|
nimble build
|
||||||
|
```
|
||||||
|
|
||||||
|
### Running
|
||||||
|
|
||||||
|
```
|
||||||
|
nimble run
|
||||||
|
```
|
Loading…
Reference in New Issue
Block a user