Skip to content

Commit 5ee5533

Browse files
committed
link the manual and docs in the readme
1 parent 7cddaba commit 5ee5533

File tree

2 files changed

+7
-0
lines changed

2 files changed

+7
-0
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,10 @@ The project, currently in the alpha stage, aims for rapid loading of GLTF files,
77
Development emphasizes performance, ergonomics, observability and the use of modern rendering techniques like forward+ rendering and
88
physically based shading.
99

10+
Read the [manual](https://renderling.xyz/manual/index.html) to get started.
11+
12+
Read the [docs](https://renderling.xyz/docs/renderling/index.html) for more info.
13+
1014
Visit <https://renderling.xyz> to read the development blog.
1115

1216
<img width="912" alt="ibl_environment_test" src="https://github.com/schell/renderling/assets/24942/297d6150-64b2-45b8-9760-12b27dc8cc3e">

crates/renderling/src/lib.rs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -241,6 +241,9 @@ pub mod ui;
241241

242242
pub extern crate glam;
243243

244+
// TODO: document the crate's feature flags here.
245+
// Similar to [ndarray](https://docs.rs/ndarray/latest/ndarray/#crate-feature-flags).
246+
244247
#[macro_export]
245248
/// A wrapper around `std::println` that is a noop on the GPU.
246249
macro_rules! println {

0 commit comments

Comments
 (0)