From c57897607136ad9930f665d84e3f1b79ee86b779 Mon Sep 17 00:00:00 2001 From: Canleskis <91223490+Canleskis@users.noreply.github.com> Date: Sat, 17 Feb 2024 02:15:48 +0100 Subject: [PATCH] Update README.md --- particular/CHANGELOG.md | 2 +- particular/README.md | 8 +++++++- 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/particular/CHANGELOG.md b/particular/CHANGELOG.md index b73ee69..ef93f29 100644 --- a/particular/CHANGELOG.md +++ b/particular/CHANGELOG.md @@ -15,7 +15,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - `force_scalar`, `force_simd` methods and various constructors for `PointMass`. - `ScalarArray` trait to bind a `FloatVector` and an array for `Particle` to `PointMass` conversion. - Marker `ReorderedCompute` trait. -- `Softened` variants for all CPU compute methods. +- `Softened` variants for all compute methods. ### Changed diff --git a/particular/README.md b/particular/README.md index b2788eb..edbf6ec 100644 --- a/particular/README.md +++ b/particular/README.md @@ -11,10 +11,16 @@ Particular is a crate providing a simple way to simulate N-body gravitational interaction of particles in Rust. +Please note that this branch is for development purposes and may not represent the latest stable +release of the library. For the most recent stable version, refer to the +[`latest`](https://github.com/Canleskis/particular/tree/latest) branch. + +## [Change log](https://github.com/Canleskis/particular/blob/main/particular/CHANGELOG.md) + ## Goals The main goal of this crate is to provide users with a simple API to set up N-body gravitational -simulations that can easily be integrated into existing game and physics engines. Thus it does +simulations that can easily be integrated into existing game and physics engines. Thus it doe not concern itself with numerical integration or other similar tools and instead only focuses on the acceleration calculations.