417261 - Re-write mac readme

Status: RESOLVED FIXED

(SeaMonkey :: Installer, defect)

Description

[Stefan [:stefanh]]

Once bug 406448 is resolved, SeaMonkey mac users will, for the first time, be able to actually read the readme file (it has been buried in the .app bundle before). We need to update the file and make it reflect the context (users who read the file have already downloaded and opened the disk image etc).

Comment 1

[Stefan [:stefanh]]

Attachment: New readme for mac

Attaching the new mac readme. Will attach a patch in a few minutes.

Comment 2

[Stefan [:stefanh]]

Attachment: patch, new readme for mac

So, I figured Karsten could look at the content and Kairo could do a complementary review here. Note that I don't mention about:license since that just points to eulas for MoCo apps. Instead I just point to the seamonkey eula at mozilla.org.

Comment 3

[Stefan [:stefanh]]

Btw, I think linking to the eula is our best choice even if toolkit's license.html get fixed - about:license sort of require that you have installed the application.  

Comment 4

[Robert Kaiser]

Comment on attachment 307042 [details] [diff] [review]
patch, new readme for mac

Yes, looks good. r=me

Comment 5

[Stefan [:stefanh]]

Comment on attachment 307042 [details] [diff] [review]
patch, new readme for mac

Just some reflections, looking at this again:

+  - Macintosh computer with an Intel x86 or PowerPC G3/G4/G5 processor

Might be enough with "Intel x86 or PowerPC G3/G4/G5 processor" assuming the reader is on a mac...

+  - 100 MB of free hard disk space

Actually I think we want to bump this up. The binary is around 64MB and iirc disk cache is 50MB. Firefox has 200MB and I think we might want to have that as well.

Comment 6

[Karsten Düsterloh]

Comment on attachment 307042 [details] [diff] [review]
patch, new readme for mac

I'll do this review based upon the text version in attachment #307040 [details], as it's much more readable... ;-)

>   Please also make sure to read the release notes at
>   
>   http://www.seamonkey-project.org/releases/
> 
>   for information on known problems and installation issues. The release notes
>   can be found at the preceding URL along with the releases themselves.

This sounds a bit clumsy. How about:

For information on known problems and installation issues, please do read the release notes!
They can be found along with the relases at
  http://www.seamonkey-project.org/releases/

>   - Macintosh computer with an Intel x86 or PowerPC G3/G4/G5 processor
>   - 256 MB RAM
>   - 100 MB of free hard disk space

Yes, 200 MB are okay with me.

>   Where Information is Stored
>   ---------------------------
> 
>   When you run SeaMonkey the first time, a "SeaMonkey" folder is created in

... run SeaMonkey for the first ...

>   ~/Library/Application Support/ (where ~ is your home directory).
> 
>   Your personal settings, bookmarks, e-mail, passwords etc are stored in a

etc. 
(Trailing dot missing here and at several other locations in the file.)

>   Uninstallation
>   --------------
> 
>   To uninstall SeaMonkey (and keep your personal settings, bookmarks etc),

s/and/but

>   Getting SeaMonkey
>   -----------------

I'd rather see the warning first in this paragraph, before any download links.
How about:

For testing purposes, nightly builds of SeaMonkey are provided regularly. They reflect the current code without any testing and may be buggy. 

Nightly builds of various dates are available from the mozilla.org FTP site at 
  http://ftp.mozilla.org/pub/mozilla.org/seamonkey/nightly/

For the very latest builds, see
  http://ftp.mozilla.org/pub/mozilla.org/seamonkey/nightly/latest-trunk/

If you are looking for a more polished version of SeaMonkey, grab a release version from
  http://www.seamonkey-project.org/releases/.

>   For more info on SeaMonkey, see http://www.seamonkey-project.org/. To submit
>   bugs or other feedback, see http://www.seamonkey-project.org/dev/get-involved
>   and check out Bugzilla at https://bugzilla.mozilla.org/ for links to known

s/links to//



r=me with these changes, provided some native English speaker has had a look also. ;-)

Comment 7

[Stefan [:stefanh]]

(In reply to comment #6)
> (From update of attachment 307042 [details] [diff] [review])
> I'll do this review based upon the text version in attachment #307040 [details], as it's
> much more readable... ;-)
> 
> >   Please also make sure to read the release notes at
> >   
> >   http://www.seamonkey-project.org/releases/
> > 
> >   for information on known problems and installation issues. The release notes
> >   can be found at the preceding URL along with the releases themselves.
> 
> This sounds a bit clumsy. How about:
> 
> For information on known problems and installation issues, please do read the
> release notes!
> They can be found along with the relases at
>   http://www.seamonkey-project.org/releases/

How about:

"  Please also make sure to read the release notes for information on known problems
  and installation issues. The release notes can be found at

  http://www.seamonkey-project.org/releases/ along with the releases themselves."?

> 
> >   - Macintosh computer with an Intel x86 or PowerPC G3/G4/G5 processor
> >   - 256 MB RAM
> >   - 100 MB of free hard disk space
> 
> Yes, 200 MB are okay with me.

OK, I'll change to 200MB

> >   Where Information is Stored
> >   ---------------------------
> > 
> >   When you run SeaMonkey the first time, a "SeaMonkey" folder is created in
> 
> ... run SeaMonkey for the first ...

Oops, will fix.

> 
> >   ~/Library/Application Support/ (where ~ is your home directory).
> > 
> >   Your personal settings, bookmarks, e-mail, passwords etc are stored in a
> 
> etc. 
> (Trailing dot missing here and at several other locations in the file.)

Hmm, don't see any missing dots. If you mean the lists, I have chosen to not use any period after each item.

> 
> >   Uninstallation
> >   --------------
> > 
> >   To uninstall SeaMonkey (and keep your personal settings, bookmarks etc),
> 
> s/and/but

Will fix.

> 
> >   Getting SeaMonkey
> >   -----------------
> 
> I'd rather see the warning first in this paragraph, before any download links.
> How about:
> 
> For testing purposes, nightly builds of SeaMonkey are provided regularly. They
> reflect the current code without any testing and may be buggy. 
> 
> Nightly builds of various dates are available from the mozilla.org FTP site at 
>   http://ftp.mozilla.org/pub/mozilla.org/seamonkey/nightly/
> 
> For the very latest builds, see
>   http://ftp.mozilla.org/pub/mozilla.org/seamonkey/nightly/latest-trunk/
> 
> If you are looking for a more polished version of SeaMonkey, grab a release
> version from
>   http://www.seamonkey-project.org/releases/.

How about:

"For testing purposes, nightly builds of SeaMonkey are provided regularly. They
reflect the current development and may be buggy.

Nightly builds of various dates are available from the mozilla.org FTP site at 
  http://ftp.mozilla.org/pub/mozilla.org/seamonkey/nightly/

For the very latest builds, see
  http://ftp.mozilla.org/pub/mozilla.org/seamonkey/nightly/latest-trunk/

If you are looking for a more polished version of SeaMonkey, the SeaMonkey project releases
builds of SeaMonkey regularly that you can download from

http://www.seamonkey-project.org/releases/."? (I don't mind "grab a release", but the person who reads this could be about to install a release build)

> 
> >   For more info on SeaMonkey, see http://www.seamonkey-project.org/. To submit
> >   bugs or other feedback, see http://www.seamonkey-project.org/dev/get-involved
> >   and check out Bugzilla at https://bugzilla.mozilla.org/ for links to known
> 
> s/links to//

Just so I understand: You can't get all the info from those 2 pages, but they provide links to information. You mean that it's obvious?

Comment 8

[Karsten Düsterloh]

> > For information on known problems and installation issues, please do read the
> > release notes!
> > They can be found along with the relases at
> >   http://www.seamonkey-project.org/releases/
> 
> How about:
> 
> "  Please also make sure to read the release notes for information on 
>    known problems and installation issues. The release notes can be found at
> 
>   http://www.seamonkey-project.org/releases/ along with the releases
> themselves."?

I especially hate the "make sure to read" and the "themselves" apodosis.

> Hmm, don't see any missing dots. If you mean the lists, I have chosen to not
> use any period after each item.

My sources require "etc." with a trailing dot if not at the end of the sentence.

> "For testing purposes, nightly builds of SeaMonkey are provided regularly.
> They reflect the current development and may be buggy.

Yeah, that's better.

> If you are looking for a more polished version of SeaMonkey, the SeaMonkey
> project releases
> builds of SeaMonkey regularly that you can download from
> 
> http://www.seamonkey-project.org/releases/."?

Well, our releases aren't exactly done "regularly". ;-)

How about:
"If you are looking for a more polished version of SeaMonkey, you can downlooad official releases from

http://www.seamonkey-project.org/releases/."

> I don't mind "grab a release",
> but the person who reads this could be about to install a release build)

Yeah, true.

> > >   and check out Bugzilla at https://bugzilla.mozilla.org/ for links to
> > 
> > s/links to//
> 
> Just so I understand: You can't get all the info from those 2 pages, but they
> provide links to information. You mean that it's obvious?

Yes, that's part of "more" if anyone wants to nitpick. The net is linkified by nature, no need to mention it, imo.

Comment 9

[Stefan [:stefanh]]

(In reply to comment #8)
> > > For information on known problems and installation issues, please do read the
> > > release notes!
> > > They can be found along with the relases at
> > >   http://www.seamonkey-project.org/releases/
> > 
> > How about:
> > 
> > "  Please also make sure to read the release notes for information on 
> >    known problems and installation issues. The release notes can be found at
> > 
> >   http://www.seamonkey-project.org/releases/ along with the releases
> > themselves."?
> 
> I especially hate the "make sure to read" and the "themselves" apodosis.

OK. How about:

  "For information on known problems and installation issues, please read the
  release notes. They can be found along with the releases at
  
  http://www.seamonkey-project.org/releases/."
> 
> > Hmm, don't see any missing dots. If you mean the lists, I have chosen to not
> > use any period after each item.
> 
> My sources require "etc." with a trailing dot if not at the end of the
> sentence.

You're right, sorry. I'll fix it.
> 
> > "For testing purposes, nightly builds of SeaMonkey are provided regularly.
> > They reflect the current development and may be buggy.
> 
> Yeah, that's better.
> 
> > If you are looking for a more polished version of SeaMonkey, the SeaMonkey
> > project releases
> > builds of SeaMonkey regularly that you can download from
> > 
> > http://www.seamonkey-project.org/releases/."?
> 
> Well, our releases aren't exactly done "regularly". ;-)
> 
> How about:
> "If you are looking for a more polished version of SeaMonkey, you can downlooad
> official releases from
> 
> http://www.seamonkey-project.org/releases/."

Yeah, that sounds good.

> 
> > I don't mind "grab a release",
> > but the person who reads this could be about to install a release build)
> 
> Yeah, true.
> 
> > > >   and check out Bugzilla at https://bugzilla.mozilla.org/ for links to
> > > 
> > > s/links to//
> > 
> > Just so I understand: You can't get all the info from those 2 pages, but they
> > provide links to information. You mean that it's obvious?
> 
> Yes, that's part of "more" if anyone wants to nitpick. The net is linkified by
> nature, no need to mention it, imo.
>

Right, I agree

Comment 10

[Karsten Düsterloh]

> OK. How about:
> 
>   "For information on known problems and installation issues, please read the
>   release notes. They can be found along with the releases at
> 
>   http://www.seamonkey-project.org/releases/."

Yeah, that's better.

Comment 11

[Stefan [:stefanh]]

Attachment: final version

Attaching the final version. Changed "Nightly builds of various dates are available from..." to "Nightly builds from various dates are available on..." per discussion with ajschult (thanks)

Comment 12

[Stefan [:stefanh]]

Comment on attachment 308323 [details] [diff] [review]
final version

whoops

Comment 13

[Stefan [:stefanh]]

Checking in suite/locales/en-US/installer/mac/README.txt;
/cvsroot/mozilla/suite/locales/en-US/installer/mac/README.txt,v  <--  README.txt
new revision: 1.4; previous revision: 1.3
done