https://github.com/r4gus/sugar-ray
Ray Tracer written in Rust
https://github.com/r4gus/sugar-ray
raytracer raytracing rust
Last synced: about 1 month ago
JSON representation
Ray Tracer written in Rust
- Host: GitHub
- URL: https://github.com/r4gus/sugar-ray
- Owner: r4gus
- License: mit
- Created: 2020-10-05T20:35:51.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2020-11-01T17:46:01.000Z (over 4 years ago)
- Last Synced: 2025-01-26T19:36:56.192Z (3 months ago)
- Topics: raytracer, raytracing, rust
- Language: Rust
- Homepage:
- Size: 495 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]
Sugar-Ray
A Ray Tracer written in Rust.
Explore the docs »
Report Bug
·
Request Feature
## Table of Contents
* [About the Project](#about-the-project)
* [Built With](#built-with)
* [Getting Started](#getting-started)
* [Prerequisites](#prerequisites)
* [Installation](#installation)
* [Usage](#usage)
* [Roadmap](#roadmap)
* [Contributing](#contributing)
* [License](#license)
* [Contact](#contact)
* [Acknowledgements](#acknowledgements)
## About The Project
__Sugar-Ray__ is currently able to generate very basic 2D images. You can check out the
[images](https://github.com/r4gus/sugar-ray/tree/main/images) folder for example images
and the [examples](https://github.com/r4gus/sugar-ray/tree/main/src/examples) folder for example programs.
![Sphere]("https://github.com/r4gus/tree/main/images/sphere.jpg")
### Built With
* [Rust](https://www.rust-lang.org)
## 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:
```Bash
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
```
#### Windows
For Windows see: [other Rust installation methods](https://forge.rust-lang.org/infra/other-installation-methods.html).
### Installation
1. Clone the repo
```sh
git clone https://github.com/r4gus/sugar-ray.git
```
2. Switch into the folder and run
```sh
cargo test
```
to run the tests.
## Usage
Check out the [examples](https://github.com/r4gus/sugar-ray/tree/main/src/examples) folder for examples on
how to use the project.
## Roadmap
See the [open issues](https://github.com/r4gus/sugar-ray/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**.
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
## License
Distributed under the MIT License. See `LICENSE` for more information.
## Contact
Project Link: [https://github.com/r4gus/sugar-ray](https://github.com/r4gus/sugar-ray)
## Acknowledgements
* [Jamis Buck (Ray Tracer Challenge)](http://raytracerchallenge.com/)
[contributors-shield]: https://img.shields.io/github/contributors/r4gus/sugar-ray?style=flat-square
[contributors-url]: https://github.com/r4gus/sugar-ray/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/r4gus/sugar-ray?style=flat-square
[forks-url]: https://github.com/r4gus/sugar-ray/network
[stars-shield]: https://img.shields.io/github/stars/r4gus/sugar-ray?style=flat-square
[stars-url]: https://github.com/r4gus/sugar-ray/stargazers
[issues-shield]: https://img.shields.io/github/issues/r4gus/sugar-ray?style=flat-square
[issues-url]: https://github.com/r4gus/sugar-ray/issues
[license-shield]: https://img.shields.io/github/license/r4gus/sugar-ray?style=flat-square
[license-url]: https://github.com/r4gus/sugar-ray/blob/main/LICENSE
[product-screenshot]: images/screenshot.png