[Wtr-development] README file to github!?

Bret Pettichord bret at pettichord.com
Fri Oct 1 19:54:15 EDT 2010


I've updated master so that all the gems now use the one readme.

I will also make these changes to the 1.6.6 release branch.

Bret

On Fri, Oct 1, 2010 at 1:59 PM, marekj <marekj.com at gmail.com> wrote:

> On Fri, Oct 1, 2010 at 1:41 PM, Jarmo <jarmo.p at gmail.com> wrote:
> > That's just not true. It might be the case at the moment, but i have a
> > plan to fix that. In my mind there should be still 1 README on github
> > and when gems are being made then that same README should be copied
> > into 3 gems. So every gem would have the same README. I don't see much
> > of a point of having different readme-s
>
> Thanks Jarmo, now I know what you mean to have one README as a
> template. I had not thought of that.
>
> > though since the API should be
> > same anyway (i know it currently isn't 100%, but that shouldn't be in
> > the readme anyway).
> >
> > As you can see then currently on the github isn't any VERSION or
> > CHANGES in commonwatir, watir or firewatir directory, but they're
> > still there when you install gems. Same plan goes to README.
> >
> > Jarmo
> >
> > On Fri, Oct 1, 2010 at 7:33 PM, marekj <marekj.com at gmail.com> wrote:
> >> I wanted to explain and defend my view of why there are 4 README.rdoc
> >> files in watir project.
> >>
> >> Watir project on github has a README.rdoc file as a landing page which
> >> is used to present the project and its 3 separate gems.
> >> Each library firewatir, watir, commonwatir has a README.rdoc specific
> >> to that library so each gem then has it's own readme.
> >> The main top level readme never makes it to the user's machine when
> >> they install the gems.
> >> If the user runs rdoc generation from the gems on their own machine
> >> they now have a local README for each one of the gems.
> >> The toplevel gem is visible on github as a landing page for the project.
> >>
> >> And that is why I thought there should be 4 README.rdoc files
> >>
> >>
> >> marekj
> >>
> >> http://rubytester.com
> >>
> >>
> >>
> >>
> >> On Fri, Oct 1, 2010 at 11:02 AM, marekj <marekj.com at gmail.com> wrote:
> >>> Hi Guys,
> >>> Sorry for not being engaged over the last few months, I had to move
> >>> family from Dallas to Austin and have kids start new schools and so on
> >>> so not much time for fun.
> >>>
> >>> Please take a look here.
> >>> http://rubyforge.org/pipermail/wtr-development/2010-June/001863.html
> >>> the repo is here
> >>> http://github.com/marekj/watir/tree/rdocfix
> >>> the rdoc out of this repo is here
> >>> http://wtr.rubyforge.org/rdoc/1.6.5/
> >>>
> >>> The main objective of this fix was to fix rdoc generation, make Readme
> >>> files presentable
> >>> and also make yardoc output.
> >>>
> >>> I see that some of this didn't make it to the main watir.
> >>> Can you still use some of the fixes I made?
> >>>
> >>>
> >>>
> >>>
> >>> marekj
> >>>
> >>> http://rubytester.com
> >>>
> >>>
> >>>
> >>>
> >>> On Fri, Oct 1, 2010 at 4:42 AM, Alister Scott <alister.scott at gmail.com>
> wrote:
> >>>> Wow! Thanks for updating watir.com/examples so quickly.
> >>>> I think it's looking good. Thanks for all your work on this Željko!
> >>>>
> >>>> Cheers,
> >>>>
> >>>> Alister
> >>>>
> >>>>
> >>>> On Fri, Oct 1, 2010 at 7:20 PM, Željko Filipin
> >>>> <zeljko.filipin at wa-research.ch> wrote:
> >>>>>
> >>>>> On Thu, Sep 30, 2010 at 10:32 PM, Jarmo <jarmo.p at gmail.com> wrote:
> >>>>> > 1) There is only FireWatir examples.
> >>>>>
> >>>>> Good point. I will make separate require statements for each
> supported
> >>>>> gem.
> >>>>>
> >>>>> > 2) Maybe use hashrocket in locating elements instead of "old"
> >>>>> > comma-style?
> >>>>>
> >>>>> I did not know that => is called hashrocket :)
> >>>>>
> >>>>> I was thinking about updating docs to use hashrocket syntax but never
> had
> >>>>> the time.
> >>>>>
> >>>>> I have:
> >>>>>
> >>>>> - updated both README file and http://watir.com/examples/
> >>>>> - renamed "b" variable to "browser" to make it clear to the new
> people
> >>>>> where it points to
> >>>>> - removed "full code" section from examples page to make it easier to
> >>>>> update the code, so I do not have to do it three times (already doing
> it two
> >>>>> times, README file and Examples page)
> >>>>> - removed "Starting a new browser at our site directly" section, I do
> not
> >>>>> think it is so important that it should be included in the basic
> examples
> >>>>> - added all watir gems (stable and experimental) to README
> >>>>>
> >>>>> Please let me know if you disagree with my changes.
> >>>>>
> >>>>> More information:
> >>>>>
> >>>>> http://github.com/bret/watir/pull/8
> >>>>>
> _______________________________________________
> Wtr-development mailing list
> Wtr-development at rubyforge.org
> http://rubyforge.org/mailman/listinfo/wtr-development
>



-- 
Bret Pettichord
Lead Developer, Watir, www.watir.com

Blog, www.io.com/~wazmo/blog
Twitter, www.twitter.com/bpettichord
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://rubyforge.org/pipermail/wtr-development/attachments/20101001/e129d2f2/attachment-0001.html>


More information about the Wtr-development mailing list