Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.

Bug 353750

Summary:	Include textual descriptions right into all sample projects, e.g. a Readme.txt or a copy of the demo project wiki page
Product:	[Technology] STEM	Reporter:	Matthias Filter <matthias.filter>
Component:	UI	Assignee:	James Kaufman <jhkauf>
Status:	CLOSED FIXED	QA Contact:
Severity:	enhancement
Priority:	P3
Version:	unspecified
Target Milestone:	1.1.2
Hardware:	PC
OS:	All
Whiteboard:

Description Matthias Filter

2011-08-03 08:26:25 EDT

This could help newbees to understand what a demo project is about. Otherwise people would have to search for information on the web which is still not always feasible and sometimes also annoying.

Comment 1 James Kaufman

2011-08-03 12:55:06 EDT

Matthias,
The original idea was to up a link (url) in the dublin core but I agree with you, we need to support having either readme.txt or readme.html within a project folder and then show this in the project explorer.
We will implement this feature request and then add the associated file to the downloadable examples.

Comment 2 Matthias Filter

2011-08-03 13:03:16 EDT

Great!
Doing so, you should also start to assign version numbers to the demo projects, so users will recognize that something changed within these files as well.

Comment 3 James Kaufman

2011-08-03 20:24:34 EDT

reassigning to JK

Comment 4 James Kaufman

2011-08-03 20:26:30 EDT

I have now added
readme.html files to all of our downloadable scenarios.
Please take a look at these files and feel free to suggest improvements.
For now I'm marking this as resolved.
The readme shows up in the STEM project explorer and the browser view in the Resource Set looks good when they are clicked on.

Comment 5 James Kaufman

2011-08-05 21:22:10 EDT

Files added to projects on website