X-Git-Url: https://osm.etsi.org/gitweb/?a=blobdiff_plain;f=README.md;h=5fa8e3d540f02a3f14958af173b94a0922c73fc1;hb=refs%2Fchanges%2F54%2F8554%2F8;hp=e0f689807877dfdf2d2a85b6ec838a3273fa8a26;hpb=bc50b79b8fdcbf1c1665011ed04d85df6efcddf8;p=osm%2FPLA.git

diff --git a/README.md b/README.md
index e0f6898..5fa8e3d 100644
--- a/README.md
+++ b/README.md
@@ -14,55 +14,40 @@ implied.
 See the License for the specific language governing permissions and
 limitations under the License
 -->
-# Project Title
+# OSM PLA
 
-One Paragraph of project description goes here
+The PLA module provides computation of optimal placement of xNFs over VIMs by matching NS specific requirements to infrastructure availability and run-time metrics, while considering cost of compute/network.
 
 ## Getting Started
 
-These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
+Please refer to the [PLA User's Guide](docs/pla_users_guide.md) for a description on how to enable and configure the placement functionality.
 
-### Prerequisites
 
-What things you need to install the software and how to install them
-
-```
-Give examples
-```
-
-### Installing
-
-A step by step series of examples that tell you how to get a development env running
-
-Say what the step will be
-
-```
-Give the example
-```
-
-And repeat
-
-```
-until finished
-```
+## Running the tests
 
-End with an example of getting some data out of the system or using it for a little demo
+The preferred method to run the PLA unit test is to use tox.
 
-## Running the tests
+`$ tox`
 
-Explain how to run the automated tests for this system
+Please note that some of the unit test modules have dependencies to Minizinc, e.g. test_mznmodels.py and test_mznPlacementConductor.py.
+If these tests are to be performed outside a PLA container context, like .e.g. from CLI or from within an IDE, setup the environment as follows (linux example):
 
 ```
-Give an example
+$ sudo snap install minizinc --classic
+$ sudo mkdir -p /minizinc/bin
+$ sudo ln -s /snap/bin/minizinc /minizinc/bin/minizinc 
 ```
 
 ## Deployment
 
-Add additional notes about how to deploy this on a live system
+PLA is an optional module in OSM. It is installed together with OSM by adding ``--pla`` to the install script.
+
+`$ ./install_osm.sh --pla`
 
 ## Built With
 
-* [Python](www.python.org/) - The language used
+* [Python](www.python.org/) - the primary programming language for OSM
+* [Minizinc](www.minizinc.org) - a free and open source constraint modelling language
 
 ## Contributing
 
@@ -78,5 +63,6 @@ This project is licensed under the Apache2 License - see the [LICENSE.md](LICENS
 
 ## Acknowledgments
 
-* **Billie Thompson** - *Initial work* - [PurpleBooth](https://github.com/PurpleBooth)
+* **Paolo Dragone** - *PyMzn, a python library that wraps and enhance Minizinc* - [pymzn](https://github.com/paolodragone/pymzn)
+* **Billie Thompson** - *Initial work on README.md* - [PurpleBooth](https://github.com/PurpleBooth)