Skip to content

Commit e21a0e4

Browse files
author
naraesk
authored
Update README.md
1 parent a046489 commit e21a0e4

1 file changed

Lines changed: 15 additions & 25 deletions

File tree

generator/README.md

Lines changed: 15 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,26 @@
11
# README #
22

3-
### What is this repository for? ###
3+
## What is this repository for?
44

5-
* Software Visualization Generator (generative and model-driven software visualization)
6-
* Last build: ![Development](https://codeship.com/projects/409e3130-0a2e-0133-98c2-269fed99bda5/status?branch=development)
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.
76

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
249
* 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)
2711

28-
### Contribution guidelines ###
12+
## Contribution Guidelines
2913

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)
3214
* Don't commit generated files like in *tmp*, *xtend-gen* and *src-gen*
3315
* Commit only working and tested code
3416
* 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)
3626

0 commit comments

Comments
 (0)