include readme to avoid doc duplication

dimforge · Nov 4, 2024 · 1b7713f · 1b7713f
1 parent 7617ab0
commit 1b7713f
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 14 deletions.
diff --git a/crates/rapier3d-meshloader/README.md b/crates/rapier3d-meshloader/README.md
@@ -1,8 +1,12 @@
-## STL loader for the Rapier physics engine
+## Mesh loader for the Rapier physics engine
 
-Rapier is a set of 2D and 3D physics engines for games, animation, and robotics. The `rapier3d-stl`
+Rapier is a set of 2D and 3D physics engines for games, animation, and robotics. The `rapier3d-meshloader`
 crate lets you create a shape compatible with `rapier3d` and `parry3d` (the underlying collision-detection
-library) from an STL file.
+library) from different file formats, see the following features list:
+
+- `stl`: support .stl files
+- `collada`: support .dae files
+- `wavefront`: support .obj files
 
 ## Resources and discussions
 

diff --git a/crates/rapier3d-meshloader/src/lib.rs b/crates/rapier3d-meshloader/src/lib.rs
@@ -1,14 +1,4 @@
-//! ## Mesh loader for the Rapier physics engine
-//!
-//! Rapier is a set of 2D and 3D physics engines for games, animation, and robotics. The `rapier3d-meshloader`
-//! crate lets you create a shape compatible with `rapier3d` and `parry3d` (the underlying collision-detection
-//! library) from different file formats, see the following features list:
-//! `stl`: support .stl files
-//! `collada`: support .dae files
-//! `wavefront`: support .obj files
-//!
-//! See documentation from [`mesh_loader`] for more details.
-
+#![doc = include_str!("../README.md")]
 #![deny(missing_docs)]
 
 use mesh_loader::Mesh;