diff --git a/CHANGELOG.md b/CHANGELOG.md index ae05ecb5..1264295c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,7 +1,7 @@ -# Changelog +# Changelog ## Unreleased -## 0.1.1 [☰](https://github.com/lmorisse/symu/compare/v0.1.1..v0.1.0) -* Add new project example: SymuLearnAndForget by [@lmorisse] -* Add new project example: SymuLearnAndForgetTest by [@lmorisse] +## 0.2.0 [☰](https://github.com/lmorisse/symu/compare/v0.2.0..v0.1.0) +* Add new project example: [SymuLearnAndForget](https://github.com/lmorisse/Symu/tree/master/Symu%20examples/SymuLearnAndForget) by [@lmorisse] +* Add new project example: [SymuLearnAndForgetTest](https://github.com/lmorisse/Symu/tree/master/Symu%20examples/SymuLearnAndForgetTests) by [@lmorisse] diff --git a/README.md b/README.md index 4bd38924..8f46af5c 100644 --- a/README.md +++ b/README.md @@ -22,6 +22,13 @@ They interact simultaneously in a shared environment that interacts in turn with Because we believe that such a framework is valuable for organizations and academics. And that academics can enrich use cases and models implemented in this framework. ## Getting Started +The main project is [SymuEngine](https://github.com/lmorisse/Symu/tree/master/Symu%20source%20code/SymuEngine). This is the framework you'll use to build your own application in batch or GUI mode. +[SymuTools](https://github.com/lmorisse/Symu/tree/master/Symu%20source%20code/SymuTools) is a set of utilities for SymuEngine. +Those two projects come with their test project, mainly unit tests. They are helpful for developers to understand how to use the framework. + +The sample projects are interesting to understand what the framework can do. They are divided into models, for example [learning and forgetting models](https://github.com/lmorisse/Symu/tree/master/Symu%20examples/SymuLearnAndForget). +They also come with their test project, which are more integration tests and a guide to use this framework in batch mode. +They allow you to discover, understand and configure each model, in this sense it is a good entry point. ### Installing diff --git a/ROADMAP.md b/ROADMAP.md index b7914a89..11fe3d43 100644 --- a/ROADMAP.md +++ b/ROADMAP.md @@ -1,6 +1,6 @@ -#ROADMAP +# ROADMAP -##FRAMEWORK ROADMAP +## FRAMEWORK * App based on the framework for agnostic organizations * Implement models : ** Transactional memory @@ -8,14 +8,16 @@ ** Interaction sphere ** Risk aversion -##EXAMPLES ROADMAP +## EXAMPLES +* Belief and influence +* Tasks and messages -##TECHNICAL ROADMAP +## TECHNICAL * Persistance XML files -##WIKI ROADMAP +## WIKI * Describe models -##DOCS ROADMAP +## DOCS * User guides -* Models templates \ No newline at end of file +* Models templates