Add model to docs

krissrex · Nov 22, 2019 · c121d58 · c121d58
1 parent 425f90d
commit c121d58
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -27,8 +27,22 @@ Nginx config DSL for NTNU course TDT4250
 
 ## Grammar
 
+This is the xtext grammar that will be used to generate the Ecore model:
+
 ![grammar](docs/grammar.png)
 
+## Ecore Model
+
+This is the model generated from the xtext grammar:
+
+![ecore-model](docs/ecore-model.png)
+
+The model consists of the main `Nginx` consisting of any number of sites. The sites themselves contain a number of attributes, and two EClasses: `SSlCert` and `ErrorPage`.
+
+The sites can have several `alternative names` and several `error pages`. The error pages contain a list of `error codes` that link to a specific `uri`. Each site has a `SSL Certifiate` that can be reused for other domains or subdomains.
+
+## Conversion
+
 ## Tests
 
 The tests are located in `no.ntnu.tdt4250.tests`. For each object in the model `Site`, `SslCert` and `ErrorPage`, there is a corresponding `.xtend` test file. In addition to this, there is a `Parsing` test and a `UnquotedStringValueConverter` test.

diff --git a/docs/ecore-model.png b/docs/ecore-model.png