Skip to content

Commit

Permalink
Updated readme file.
Browse files Browse the repository at this point in the history
Converted text file to markdown file.
  • Loading branch information
Sebastian Krieter authored and Sebastian Krieter committed Apr 11, 2018
1 parent 98205b5 commit b19733c
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 8 deletions.
2 changes: 1 addition & 1 deletion plugins/de.ovgu.featureide.examples/build.properties
Expand Up @@ -17,6 +17,6 @@ bin.includes = plugin.xml,\
UpdateIndexFiles_Force.launch,\
UpdateIndexFiles.launch,\
jar/,\
readme.txt,\
readme.md,\
template_projectInformation.xml,\
build.xml
19 changes: 19 additions & 0 deletions plugins/de.ovgu.featureide.examples/readme.md
@@ -0,0 +1,19 @@
# Example Plug-In

## Description
This Plug-In enables users to import example projects into their workspace.
It contains all example projects of FeatureIDE and features an GUI wizard for importing.

## Developer Information

### How to add a new example project
1. Copy the project folder of the example in the folder `featureide_example`
2. Remove unnecessary files in the project (e.g., bin files)
3. Run the launch file `UpdateIndexFiles.launch`
4. Refresh the folder `featureide_example` _(Optional)_
5. Modify the newly created file `projectInformation.xml` in the folder of the example project _(Optional)_

### How to rebuild the list of example projects
1. Remove unnecessary files in **every** example project (e.g., bin files)
2. Run the launch file `UpdateIndexFiles_Force.launch`
3. Refresh the folder `featureide_example` _(Optional)_
7 changes: 0 additions & 7 deletions plugins/de.ovgu.featureide.examples/readme.txt

This file was deleted.

0 comments on commit b19733c

Please sign in to comment.