From 4a096014ad956d5c108d98d52817c456a8620c08 Mon Sep 17 00:00:00 2001 From: Moritz Moeller Date: Mon, 1 May 2023 21:16:36 +0200 Subject: [PATCH] README. --- crates/nsi-core/README.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/crates/nsi-core/README.md b/crates/nsi-core/README.md index 66510a8..aaed04f 100644 --- a/crates/nsi-core/README.md +++ b/crates/nsi-core/README.md @@ -1,15 +1,15 @@ # `nsi-core` This crate implements the high level wrapper around the NSI API and -links against the commercial 3Delight renderer. - -The low level wrapper around the C FFI is in the nsi-sys crate. - -This crate will likely be deprecated and split into `nsi-traits` -(describing the high level API) and `nsi-3delight` (the actual -implementation linking agains 3Delight). - -This will allow different implementations to depend on `nsi-traits`. -For example, there could be an [`nsi-moonray`](https://github.com/dreamworksanimation/openmoonray) -or [`nsi-kajira`](https://github.com/EmbarkStudios/kajiya) -crate. +links against the commercial [3Delight](https://www.3delight.com/) renderer. + +The low level wrapper around the C FFI is in the `nsi-sys` crate. + +> **Note:** This crate will likely be deprecated and split into `nsi-traits` (describing + the high level API) and `nsi-3delight` (the actual implementation linking + against 3Delight). +> +> This will allow different implementations to depend on `nsi-traits`. + For example, there could be an [`nsi-moonray`](https://github.com/dreamworksanimation/openmoonray) + or [`nsi-kajira`](https://github.com/EmbarkStudios/kajiya) + crate.