diff --git a/DEVELOP.md b/DEVELOP.md index 7cd303373e..fdfb4a3403 100644 --- a/DEVELOP.md +++ b/DEVELOP.md @@ -3,8 +3,8 @@ ### Coding Conventions * Classes are Uppercase, methods and functions lowerMixedCase. -* We use a modified K&R Style, with 2-space tabs, inserting spaces for tabs. -* Use meaningful variable names, e.g. `measurement` not `msm`. +* Apart from those naming conventions, we adopt Google C++ style. +* Use meaningful variable names, e.g. `measurement` not `msm`, avoid abbreviations. ### Windows diff --git a/README.md b/README.md index dbbba8c2b8..87d79d5576 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,9 @@ **Important Note** -As of Dec 2021, the `develop` branch is officially in "Pre 4.2" mode. A great new feature we will be adding in 4.2 is *hybrid inference* a la DCSLAM (Kevin Doherty et al) and we envision several API-breaking changes will happen in the discrete folder. +**As of January 2023, the `develop` branch is officially in "Pre 4.3" mode. We envision several API-breaking changes as we switch to C++17 and away from boost.** -In addition, features deprecated in 4.1 will be removed. Please use the last [4.1.1 release](https://github.com/borglab/gtsam/releases/tag/4.1.1) if you need those features. However, most (not all, unfortunately) are easily converted and can be tracked down (in 4.1.1) by disabling the cmake flag `GTSAM_ALLOW_DEPRECATED_SINCE_V42`. +In addition, features deprecated in 4.2 will be removed. Please use the last [4.2 release](https://github.com/borglab/gtsam/releases/tag/4.2) if you need those features. However, most are easily converted and can be tracked down (in 4.2) by disabling the cmake flag `GTSAM_ALLOW_DEPRECATED_SINCE_V42`. ## What is GTSAM?