Release v2.0.0 (#24)

* Release v2.0.0 * Fix links in docs index
AndrewIOM · Apr 24, 2024 · 5837518 · 5837518
1 parent 7431418
commit 5837518
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 5 deletions.
diff --git a/RELEASE_NOTES.MD b/RELEASE_NOTES.MD
@@ -1,6 +1,13 @@
-#### 2.0.0-alpha2 - unreleased
+#### 2.0.0 - 2024-04-24
+* FEATURE: Domain Specific Language (DSL) for scaffolding models.
+* FEATURE: User-definable RNG seeds.
+* FEATURE: Scaffold many models into competing hypotheses.
+* FEATURE: One-step-ahead analysis of model performance.
 * FEATURE: Benchmark suite of common test functions for optimisation routines
 * FEATURE: Performance tuning of optimisers. For example, Filzbach 94% faster.
+* FEATURE: Documentation website uses latest fsdocs and includes fully worked examples.
+* BREAKING: We recommend using the DSL to construct models. Underlying F# record type signatures have changed and will break version 1.x scripts.
+* BUGFIX: Amoeba functions respect end conditions.
 
 #### 2.0.0-alpha2 - 2022-04-27
 * FEATURE: Add univariate gaussian -log likelihood function

diff --git a/docs/index.fsx b/docs/index.fsx
@@ -99,16 +99,15 @@ Contributing and copyright
 
 The project is hosted on [GitHub][gh] where you can [report issues][issues], fork 
 the project and submit pull requests. If you're adding a new public API, please also 
-consider adding [samples][content] that can be turned into a documentation. You might
-also want to read the [library design notes][readme] to understand how it works.
+consider adding [samples][content] that can be turned into documentation (using fsdocs
+literal scripting).
 
 The library is available under an MIT license, which allows modification and 
 redistribution for both commercial and non-commercial purposes. For more information see the 
 [License file][license] in the GitHub repository. 
 
-  [content]: https://github.com/AndrewIOM/Bristlecone/tree/master/docs/content
+  [content]: https://github.com/AndrewIOM/Bristlecone/tree/master/docs/examples
   [gh]: https://github.com/AndrewIOM/Bristlecone
   [issues]: https://github.com/AndrewIOM/Bristlecone/issues
-  [readme]: https://github.com/AndrewIOM/Bristlecone/blob/master/README.md
   [license]: https://github.com/AndrewIOM/Bristlecone/blob/master/LICENSE
 *)