diff --git a/README.md b/README.md index 8c41ec4..4c41623 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ Specialization of objects in EO programs. -SPECO is a tool that is aimed to be launched on the EO program converted to a collection of .xmir files, +**Speco** is a tool that is aimed to be launched on the EO program converted to a collection of .xmir files, which has undergone modifications performed by [AOI](https://github.com/objectionary/aoi) tool. Consider the following EO program: @@ -75,21 +75,21 @@ It does not give any hints on what object `x` may be in this context. ``` -SPECO makes it obvious what `x` is in the provided context. For example, it will turn object `pet1` -into these two declarations of objects `pet1_spec_x=cat` and `pet1_spec_x=dog`, which are specific +**Speco** makes it obvious what `x` is in the provided context. For example, it will turn object `pet1` +into these two declarations of objects `pet1_spec_x_cat` and `pet1_spec_x_dog`, which are specific for `cat` and `dog` correspondingly. ``` - - + + ``` ``` - - + + @@ -114,11 +114,21 @@ To run a transformation: $ java -jar speco.jar --source= --target= ``` -or use make command: +or use make command for `.xmir`: ```bash $ make trans ``` +## How it works + +### Transformations + +TODO: specification of each transformation + +### Project Structure + +TODO: about classes and functions (if it is developer guide, then there are good comments, if user guide, then it should be in Usage) + ## How to Contribute Fork repository, make changes, send us a pull request.