Sugar-Ray
A Ray Tracer written in Rust.
Explore the docs »
Report Bug
·
Request Feature
Table of Contents
About The Project
Sugar-Ray is currently able to generate very basic 2D images. You can check out the images folder for example images and the examples folder for example programs.
Built With
Getting Started
To get a local copy up and running follow these simple steps.
Prerequisites
First you need to install Rust.
Linux
On Linux you can just run the following in the command line and then follow the instructions:
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
Windows
For Windows see: other Rust installation methods.
Installation
- Clone the repo
git clone https://github.com/r4gus/sugar-ray.git
- Switch into the folder and run
cargo test
to run the tests.
Usage
Check out the examples folder for examples on how to use the project.
Roadmap
See the open issues for a list of proposed features (and known issues).
Contributing
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
License
Distributed under the MIT License. See LICENSE
for more information.
Contact
Project Link: https://github.com/r4gus/sugar-ray