Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.
Bug 340434 - README.txt should have platform-specific instructions
Summary: README.txt should have platform-specific instructions
Status: CLOSED DUPLICATE of bug 347870
Alias: None
Product: Orion
Classification: ECD
Component: Client (show other bugs)
Version: 0.2   Edit
Hardware: All All
: P3 normal (vote)
Target Milestone: ---   Edit
Assignee: Andrew Niefer CLA
QA Contact:
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2011-03-18 10:45 EDT by Mark Macdonald CLA
Modified: 2011-08-30 10:21 EDT (History)
1 user (show)

See Also:

Attachments
Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.
Description Mark Macdonald CLA 2011-03-18 10:45:10 EDT 
Currently the README.txt file included in Orion builds says:

> Running
>	./eclipse
> will start the http server on port 8080.  Open a browser on 
>	http://localhost:8080
> to get started.

These steps really only make sense on Linux. On Mac OS, you need to double-click Eclipse.app and on Windows run eclipse.exe.

Also, the README uses \n for newlines, so on Windows it displays as one very long line and is hard to read.
Comment 1 Remy Suen CLA 2011-03-18 10:51:39 EDT 
Please consider addressing this for M7. I would also suggest appending the Java 6 requirement to the text file.

Thank you.
Comment 2 Andrew Niefer CLA 2011-03-31 14:16:40 EDT 
I have setup platform specific README.TXT files:
org.eclipse.orion.releng/builder/rootfiles/win32
org.eclipse.orion.releng/builder/rootfiles/linux
org.eclipse.orion.releng/builder/rootfiles/mac

They are all just the same README currently, I haven't changed the actual content yet.

Regarding the newlines on windows, I think we have to do something to git for this because we are checking out on a linux machine for the build.
Comment 3 Mark Macdonald CLA 2011-03-31 14:37:10 EDT 
> Regarding the newlines on windows, I think we have to do something to git for
> this because we are checking out on a linux machine for the build.

The eol=crlf attribute in gitattributes [1] may be what we want.

[1] http://www.kernel.org/pub/software/scm/git/docs/gitattributes.html
Comment 4 Andrew Niefer CLA 2011-03-31 14:40:18 EDT 
John also suggested perhaps using html instead of plain text which avoids the line ending problem.
Comment 5 Andrew Niefer CLA 2011-06-01 11:33:42 EDT 
We will be combining the platform specific readme's into a single html file

*** This bug has been marked as a duplicate of bug 347870 ***