feat: optional nightly (#221)

* feat: optional nightly

* docs: correction

Author: mosure

Cargo.toml

@@ -57,6 +57,8 @@ default = [
   # "morph_particles",
   "morph_interpolate",
 
+  "nightly_generic_alias",
+
   "sort_bitonic",
   "sort_radix",  # TODO: fix macos radix sort
   "sort_rayon",
@@ -80,6 +82,8 @@ material_noise = ["noise", "dep:noise"]
 morph_particles = []
 morph_interpolate = []
 
+nightly_generic_alias = []
+
 noise = []
 
 sh0 = []

README.md

@@ -10,13 +10,15 @@ bevy gaussian splatting render pipeline plugin. view the [live demo](https://mos
 ![Alt text](docs/go.gif)
 
 
-## install cli
+## install
 
 ```bash
-cargo install bevy_gaussian_splatting
+cargo +nightly install bevy_gaussian_splatting
 bevy_gaussian_splatting --input-cloud [file://gaussian.ply | https://mitchell.mosure.me/go_trimmed.ply]
 ```
 
+> note: default bevy_gaussian_splatting features require nightly rust for generic associated types. to use on stable, disable default features and `nightly_generic_alias` feature
+
 
 ## capabilities
 

src/lib.rs

@@ -1,5 +1,5 @@
 #![allow(incomplete_features)]
-#![feature(lazy_type_alias)]
+#![cfg_attr(feature = "nightly_generic_alias", feature(lazy_type_alias))]
 
 use bevy::prelude::*;
 pub use bevy_interleave::prelude::*;