New crate names, improved docs

.gitmodules

@@ -1,3 +1,3 @@
-[submodule "crates/jolt-sys/JoltC"]
-	path = crates/jolt-sys/JoltC
+[submodule "crates/joltc-sys/JoltC"]
+	path = crates/joltc-sys/JoltC
 	url = ../JoltC.git

README.md

@@ -4,15 +4,15 @@ Rust bindings for [Jolt Physics](https://github.com/jrouwe/JoltPhysics) 5.0.0 us
 This project is an early work in progress. Watch for exposed nails.
 
 ## Goals
-1. `jolt-sys`: Functioning, up-to-date unsafe bindings to Jolt Physics
-2. `jolt`: Ergonomic, safe bindings to Jolt Physics
+1. `joltc-sys`: Functioning, up-to-date unsafe bindings to Jolt Physics
+2. `rolt`: Ergonomic, safe bindings to Jolt Physics
 
 ## Crates
 
-### `jolt-sys` — Jolt bindings via [JoltC]
+### `joltc-sys` — Jolt bindings via [JoltC]
 This crate contains unsafe bindings to JoltC.
 
-### `jolt` — aspirationally safe Rust Jolt bindings
+### `rolt` — aspirationally safe Rust Jolt bindings
 This crate contains a higher-level wrapper around JoltC, providing ergonomics comparable to using Jolt from C++.
 
 The safety of this crate is currently provided on a best-effort basis.
@@ -23,6 +23,13 @@ This is a port of Jolt's [HelloWorld] example to Rust using `jolt-sys`. It isn't
 ### `hello-world` — HelloWorld using `jolt`
 This is a port of Jolt's [HelloWorld] example to Rust using the `jolt` crate. The goal of this example is to replicate the behavior of the original example entirely in safe Rust.
 
+## Submodules
+This repository uses Git submodules. Make sure to initialize submodules recursively so that JoltC and Jolt are both referenced correctly in your checkout:
+
+```bash
+git submodule update --init --recursive
+```
+
 ## License
 Licensed under either of
 

crates/hello-world-sys/Cargo.toml

@@ -6,4 +6,4 @@ edition = "2021"
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
-jolt-sys = { path = "../jolt-sys" }
+joltc-sys = { path = "../joltc-sys" }

crates/hello-world-sys/README.md

@@ -1,4 +1,4 @@
-# Hello World (jolt-sys)
-A port of the Jolt Physics "HelloWorld" sample using `jolt-sys`.
+# Hello World (joltc-sys)
+A port of the Jolt Physics "HelloWorld" sample using `joltc-sys`.
 
 This example is full of unsafe code because it's using the JoltC API.

crates/hello-world-sys/src/main.rs

@@ -2,8 +2,8 @@ use std::ffi::{c_uint, c_void, CStr};
 use std::mem::MaybeUninit;
 use std::ptr;
 
-// Everything prefixed with `JPC_` comes from the jolt_sys crate.
-use jolt_sys::*;
+// Everything prefixed with `JPC_` comes from the joltc_sys crate.
+use joltc_sys::*;
 
 const OL_NON_MOVING: JPC_ObjectLayer = 0;
 const OL_MOVING: JPC_ObjectLayer = 1;

crates/hello-world/Cargo.toml

@@ -6,5 +6,5 @@ edition = "2021"
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
-jolt = { path = "../jolt" }
-jolt-sys = { path = "../jolt-sys" }
+rolt = { path = "../rolt" }
+joltc-sys = { path = "../joltc-sys" }

crates/hello-world/src/main.rs

@@ -5,10 +5,10 @@ use std::ffi::{c_void, CStr};
 use std::mem::MaybeUninit;
 use std::ptr;
 
-// Everything prefixed with `JPC_` comes from the jolt_sys crate.
-use jolt_sys::*;
+// Everything prefixed with `JPC_` comes from the joltc_sys crate.
+use joltc_sys::*;
 
-use jolt::{BodyId, BroadPhaseLayer, BroadPhaseLayerInterface, ObjectLayer, Vec3};
+use rolt::{BodyId, BroadPhaseLayer, BroadPhaseLayerInterface, ObjectLayer, Vec3};
 
 const OL_NON_MOVING: JPC_ObjectLayer = 0;
 const OL_MOVING: JPC_ObjectLayer = 1;
@@ -74,9 +74,9 @@ fn rvec3(x: Real, y: Real, z: Real) -> JPC_RVec3 {
 }
 
 fn main() {
-    jolt::register_default_allocator();
-    jolt::factory_init();
-    jolt::register_types();
+    rolt::register_default_allocator();
+    rolt::factory_init();
+    rolt::register_types();
 
     unsafe {
         let temp_allocator = JPC_TempAllocatorImpl_new(10 * 1024 * 1024);
@@ -91,7 +91,7 @@ fn main() {
 
         let object_vs_object_layer_filter = JPC_ObjectLayerPairFilter_new(ptr::null_mut(), OVO);
 
-        let physics_system = jolt::PhysicsSystem::new();
+        let physics_system = rolt::PhysicsSystem::new();
 
         let max_bodies = 1024;
         let num_body_mutexes = 0;
@@ -197,8 +197,8 @@ fn main() {
         JPC_TempAllocatorImpl_delete(temp_allocator);
     }
 
-    jolt::unregister_types();
-    jolt::factory_delete();
+    rolt::unregister_types();
+    rolt::factory_delete();
 
     println!("Hello, world!");
 }

crates/jolt-sys/Cargo.toml → crates/joltc-sys/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
-name = "jolt-sys"
-description = "Unsafe bindings to Jolt Physics"
+name = "joltc-sys"
+description = "Unsafe bindings to Jolt Physics using JoltC"
 version = "0.1.0+Jolt-5.0.0"
 license = "MIT OR Apache-2.0"
 repository = "https://github.com/SecondHalfGames/jolt-rust"

crates/jolt/Cargo.toml → crates/rolt/Cargo.toml

@@ -1,17 +1,17 @@
 [package]
-name = "jolt"
+name = "rolt"
 description = "Safe(-ish) bindings to Jolt Physics"
 version = "0.1.0+Jolt-5.0.0"
 license = "MIT OR Apache-2.0"
 repository = "https://github.com/SecondHalfGames/jolt-rust"
 edition = "2021"
 
 [features]
-double-precision = ["jolt-sys/double-precision"]
-object-layer-u32 = ["jolt-sys/object-layer-u32"]
+double-precision = ["joltc-sys/double-precision"]
+object-layer-u32 = ["joltc-sys/object-layer-u32"]
 
 [dependencies]
-jolt-sys = { version = "0.1.0", path = "../jolt-sys" }
+joltc-sys = { version = "0.1.0", path = "../joltc-sys" }
 
 [lints.clippy]
 new_without_default = { level = "allow" }

crates/jolt/src/body_interface.rs → crates/rolt/src/body_interface.rs

@@ -1,6 +1,6 @@
 use std::marker::PhantomData;
 
-use jolt_sys::*;
+use joltc_sys::*;
 
 use crate::{BodyId, RVec3, Vec3};
 

crates/jolt/src/interfaces.rs → crates/rolt/src/interfaces.rs

@@ -2,7 +2,7 @@ use std::ffi::{c_uint, c_void};
 use std::marker::PhantomData;
 use std::ptr;
 
-use jolt_sys::*;
+use joltc_sys::*;
 
 use crate::{BroadPhaseLayer, ObjectLayer};
 

crates/jolt/src/lib.rs → crates/rolt/src/lib.rs

@@ -1,4 +1,4 @@
-use jolt_sys::*;
+use joltc_sys::*;
 
 mod body_interface;
 mod interfaces;

crates/jolt/src/math.rs → crates/rolt/src/math.rs

@@ -1,6 +1,6 @@
-use jolt_sys::{JPC_Color, JPC_DVec3, JPC_Quat, JPC_Vec3};
+use joltc_sys::{JPC_Color, JPC_DVec3, JPC_Quat, JPC_Vec3};
 
-pub use jolt_sys::Real;
+pub use joltc_sys::Real;
 
 #[cfg(feature = "double-precision")]
 pub type RVec3 = DVec3;

crates/jolt/src/physics_system.rs → crates/rolt/src/physics_system.rs

@@ -1,6 +1,6 @@
 use std::ptr;
 
-use jolt_sys::*;
+use joltc_sys::*;
 
 use crate::{BodyInterface, IntoBroadPhaseLayerInterface};
 

crates/jolt/src/simple_types.rs → crates/rolt/src/simple_types.rs

@@ -1,4 +1,4 @@
-use jolt_sys::*;
+use joltc_sys::*;
 
 #[derive(Debug, Clone, Copy, PartialEq, Eq)]
 pub struct ObjectLayer(JPC_ObjectLayer);