chore: added some doc to lib.rs

src/lib.rs

@@ -16,6 +16,8 @@
 //! The setup and installation details live in the project's [guide](https://aryanpurtech.github.io/BlueEngineDocs/).
 //! A basic program in Blue Engine is as follow:
 //!
+//! ## Example
+//!
 //! ```rust
 //! use blue_engine::{
 //!     header::{ Engine, ObjectSettings },
@@ -24,7 +26,7 @@
 //!
 //! fn main() {
 //!     // initialize the engine
-//!     let mut engine = Engine::new().expect("win");
+//!     let mut engine = Engine::new().expect("engine couldn't be initialized");
 //!
 //!     // create a triangle
 //!     triangle("my triangle", ObjectSettings::default(), &mut engine.renderer, &mut engine.objects).unwrap();
@@ -36,23 +38,28 @@
 //! }
 //! ```
 //!
-//! ## Guide for code navigation
-//!
-//! The code of the engine is organized in a rather different manner than traditional in the
-//! language. There are inspirations from other languages to make it easier to navigate the
-//! project.
-//!
-//! * `header` - contains all the declarations such as structs, exports, enums, ...
-//!
-//! The other files contain definitions for each part.
+//! ## Utilities
 //!
-//! * `objects` - contains the definition for Object type, which is a type that make it easier to manage data for rendering.
-//! * `primitive_shapes` - contains definition for some 2D and 3D shapes. They are basic shapes and
-//! can be used as examples of how to create your own content.
-//! * `render` - contains definition for rendering part of the engine.
-//! * `utils` - Utilities for the engine (soon moving to it's own
-//! [crate](https://github.com/AryanpurTech/BlueEngineUtilities)).
-//! * `window` - contains definition for creation of window and instance creation.
+//! This crate is the core of the engine, but there is also [utilities crate](https://github.com/AryanpurTech/BlueEngineUtilities)
+//! which have a lot of utilities for the engine such as lighting, physics, etc.
+//
+// ## Guide for code navigation
+//
+// The code of the engine is organized in a rather different manner than traditional in the
+// language. There are inspirations from other languages to make it easier to navigate the
+// project.
+//
+// * `header` - contains all the declarations such as structs, exports, enums, ...
+//
+// The other files contain definitions for each part.
+//
+// * `objects` - contains the definition for Object type, which is a type that make it easier to manage data for rendering.
+// * `primitive_shapes` - contains definition for some 2D and 3D shapes. They are basic shapes and
+// can be used as examples of how to create your own content.
+// * `render` - contains definition for rendering part of the engine.
+// * `utils` - Utilities for the engine (soon moving to it's own
+// [crate](https://github.com/AryanpurTech/BlueEngineUtilities)).
+// * `window` - contains definition for creation of window and instance creation.
 
 pub(crate) mod definition;
 pub mod header;