@@ -8,8 +8,36 @@ specification by the *Object Management Group* (OMG) (see [here](https://www.omg
88## Licensing
99For licensing information, please see the [ LICENSE.md] ( https://github.com/HammerMaximilian/fUML-CPP/blob/master/LICENSE ) file.
1010
11+ ## Prerequisites
12+ For detailed information, please see the [ User Guide] ( fUML-C++_User_Guide.pdf ) section * 1. Prerequisites* .
13+ ### 1. Required Software
14+ * Compiler: * GCC* (Linux) or * MinGW-w64* (Windows)
15+ * * Java Runtime Environment*
16+ * * Eclipse CDT* or any Eclipse IDE with * C++-Development Tools* installed
17+ ### 2. Recommended but optional Software
18+ * * Eclipse Modeling Tools* for creating UML models
19+ * * Eclipse Papyrus* for more sophisticated and graphical modeling of UML models
20+ * * Acceleo* to be able to use the code generator for executable models
21+
22+ ## Setup
23+ For detailed information, please see the [ User Guide] ( fUML-C++_User_Guide.pdf ) section * 2. Setup* .
24+ ### 1. Setting up Eclipse
25+ * Import fUML-C++ root project * fUML-CPP* into your workspace
26+ * Import nested projects * uml* and * fuml*
27+ ### 2. Environment Variables
28+ * Add binary directories paths of * uml* and * fuml* to your system's environment variables (e.g. add them to PATH in Windows)
29+ * Depending on whether you want to build debug version, release version or both versions of the dynamic libraries:
30+ * ` %fUML-C++_root%\uml\Debug ` for debug version of uml
31+ * ` %fUML-C++_root%\uml\Release ` for release version of uml
32+ * ` %fUML-C++_root%\fuml\Debug ` for debug version of fuml
33+ * ` %fUML-C++_root%\fuml\Release ` for release version of fuml
34+
1135## Building
12- TBD
36+ For detailed information, please see the [ User Guide] ( fUML-C++_User_Guide.pdf ) section * 3. Build* .
37+ * Build dynamic libraries for * uml* and * fuml* (** in that order** ) using Eclipse C++-Development Tools managed build
38+ * Depending on your preferences and needs, build debug, release or both
1339
1440## Usage
15- TBD
41+ For detailed information, please see the [ User Guide] ( fUML-C++_User_Guide.pdf ) section * 4. Usage* .
42+ ### 1. Creating executable models using source code
43+ ### 2. Generating executable models from * .uml* models
0 commit comments