X-Git-Url: https://git.auder.net/?a=blobdiff_plain;f=README.md;h=f4e75d1f3cfd3bbfad39a19c35a6cc3a742878af;hb=e570c0aab6f7b776cb8c6ce3c7d64c585deb66a0;hp=b39f8a718d7f1141e37456213cd716361a5a361a;hpb=19addd10d9f37cc081779b9ec17f2f98ee161889;p=erdiag.git diff --git a/README.md b/README.md index b39f8a7..f4e75d1 100644 --- a/README.md +++ b/README.md @@ -5,10 +5,6 @@ Inspired by [this repository](https://code.google.com/archive/p/merisier/). This parser reads ER diagrams definition files, and produces two types of diagrams + SQL code. [Graphviz](https://www.graphviz.org/) is used on server side to translate parsed graph descriptions into SVG objects. -*TODO list:* functional integrity constraints (CIF), inter-relations constraints (or, and, xor...), inheritance with the right symbol (triangle). - -*Note:* temporary dependency to [underscore](http://underscorejs.org/); good library but used so far only for its shuffle() method. - ----- An entity is defined as follow @@ -54,8 +50,19 @@ To indicate an inheritance relation, proceed as follow Animal Cat Fish Planet Mars Venus -Finally, blocks must be separated by new lines. For a usage example, see example.html (it should render as seen in example.svg) +Finally, blocks must be separated by new lines. For a usage example, see example.html (it should render as seen in example\_\*.svg) Note that the "drawMcd" method can take a second argument, which indicates the type of graph. * "bubble" draws the standard graph, as seen [here](https://en.wikipedia.org/wiki/Entity%E2%80%93relationship_model#/media/File:ER_Diagram_MMORPG.png) for example * "compact" (default) use the same box for an entity and its attributes + +----- + +**TODO** list: + + - functional integrity constraints (CIF) + - inter-relations constraints (or, and, xor...) + - inheritance with the right symbol (triangle) + - put online somewhere (user enter graph description and get SVG + SQL) + +*Implementation note:* temporary dependency to [underscore](http://underscorejs.org/); good library but used so far only for its shuffle() method.