Skip to content

Commit bab6de8

Browse files
authored
Polish README.rst
We remove unfinished parts of readme and update the installation.
1 parent d17fc21 commit bab6de8

File tree

1 file changed

+3
-48
lines changed

1 file changed

+3
-48
lines changed

README.rst

Lines changed: 3 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -16,70 +16,25 @@ aas-smt-codegen:
1616
* ... to handle AAS Submodel Templates
1717
* ... based on the AAS Submodel Template definition given as AAS environment.
1818

19-
Motivation
20-
==========
21-
TODO
22-
23-
Therefore we can easily scale to many languages and schemas.
24-
25-
Here is a diagram to illustrate the whole process:
26-
27-
..
28-
digraph G {
29-
node [shape=rect]
30-
31-
details [label="Details of Asset Administration Shell (the book)"];
32-
metamodel [label="Meta-model in a subset of Python\n\n* Data types\n* Constraints\n* Markers"];
33-
34-
subgraph cluster_1 {
35-
label="aas-smt-codegen"
36-
color=blue
37-
labelloc="t"
38-
labeljust="r"
39-
40-
parser [label="Parser"];
41-
intermediate [label="Intermediate representation\n(Meta-model-specific, but language agnostic)"];
42-
43-
csharpgen [label="C\# generator"];
44-
javagen [label="Java generator"];
45-
46-
dot [label="..."];
47-
}
48-
49-
csharpcode [label="C\# code"];
50-
javacode [label="Java code"];
51-
52-
details -> metamodel;
53-
metamodel -> parser;
54-
parser -> intermediate;
55-
intermediate -> csharpgen;
56-
intermediate -> javagen;
57-
intermediate -> dot;
58-
csharpgen -> csharpcode;
59-
javagen -> javacode;
60-
}
61-
62-
.. image:: https://raw.githubusercontent.com/aas-core-works/aas-smt-codegen/main/diagram.svg
63-
6419
Installation
6520
============
6621
Create a virtual environment:
6722

6823
.. code-block::
6924
70-
python -m venv venv-aas-smt-codegen
25+
python -m venv venv
7126
7227
Activate it (in Windows):
7328

7429
.. code-block::
7530
76-
venv-venv-aas-smt-codegen\Scripts\activate
31+
venv\Scripts\activate
7732
7833
or in Linux and OS X:
7934

8035
.. code-block::
8136
82-
source venv-aas-smt-codegen/bin/activate
37+
source venv/bin/activate
8338
8439
Install the tool in the virtual environment from the GitHub:
8540

0 commit comments

Comments
 (0)