|
1 | 1 | # README # |
2 | 2 |
|
3 | | -### What is this repository for? ### |
| 3 | +## What is this repository for? |
4 | 4 |
|
5 | | -* Software Visualization Generator (generative and model-driven software visualization) |
6 | | -* Last build:  |
| 5 | +The generator takes a famix, dynamic, and/or hismo model as input and generates a software visualization that can be explored using the ui component. |
7 | 6 |
|
8 | | -### How do I get set up? ### |
9 | | -#### Automatically (recommended) #### |
10 | | - |
11 | | -* Follow the instructions under [Oomph Setup](https://bitbucket.org/rimue/generator/wiki/Oomph Setup) |
12 | | - |
13 | | -#### Manually (not recommended) #### |
14 | | - |
15 | | -* Download [Eclipse IDE for Java and DSL Developers](https://www.eclipse.org/downloads/packages/eclipse-ide-java-and-dsl-developers/marsr) |
16 | | -* Set 64-bit JVM in Eclipse (Window → Preferences → Java → Installed JREs) |
17 | | -* Enable "Refresh using native hooks or polling" (Window → Preferences → General → Workspace) |
18 | | -* Set UTF-8 encoding (Window → Preferences → General → Workspace → Text file encoding → Other → UTF-8) |
19 | | -* Set workspace compliance level to 1.8 (Window → Preferences → Java → Compiler) |
20 | | -* Import all projects |
21 | | - |
22 | | -### How do I build and run the generator? ### |
23 | | -* [Maven](https://bitbucket.org/rimue/generator/wiki/Maven) is used as build management system. It is used to build the generator, to run testcases and to run the mwe2 workflows |
| 7 | +## How do I build and run the generator? |
| 8 | +* [Maven](../wiki/Maven) is used as build management system. It is used to build the generator, to run testcases and to run the mwe2 workflows |
24 | 9 | * All pre-configured Run configurations are accessible via *Run → Run Configurations → Maven Build* |
25 | | -* For the initial build of the generator run *Build everything* (Note: Only necessary by manual setup) |
26 | | -* For a detailed description of the different Maven configurations, click [here](https://bitbucket.org/rimue/generator/wiki/Maven) |
| 10 | +* For a detailed description of the different Maven configurations, click [here](new link) |
27 | 11 |
|
28 | | -### Contribution guidelines ### |
| 12 | +## Contribution Guidelines |
29 | 13 |
|
30 | | -* Workflow for PhD students: [Feature Branch Workflow](https://www.atlassian.com/git/tutorials/comparing-workflows/feature-branch-workflow) |
31 | | -* Workflow for students: [Forking Workflow](https://www.atlassian.com/git/tutorials/comparing-workflows/forking-workflow) |
32 | 14 | * Don't commit generated files like in *tmp*, *xtend-gen* and *src-gen* |
33 | 15 | * Commit only working and tested code |
34 | 16 | * Write tests and change existing tests if necessary |
35 | | -* Workflows (.mwe2) belong to *org.svis.generator.run* |
| 17 | +* Generator Workflows (.mwe2) belong to *org.svis.generator.run* |
| 18 | + |
| 19 | +## Further Documentation |
| 20 | + |
| 21 | +* [Overview](../wiki/Generator%20Overview) |
| 22 | +* [Generation Process](../wiki/Generation%20Process) |
| 23 | +* [Maven](../wiki/Maven) |
| 24 | +* [Testing Process](../wiki/Testing%20Process%20Generator) |
| 25 | +* [Xtend Coding Guidelines](../wiki/Xtend%20Coding%20Guidelines) |
36 | 26 |
|
0 commit comments