Ticket #1844 (closed todo: fixed)

Opened 4 years ago

Last modified 4 years ago

Add 'git' instructions to README

Reported by: jkeenan Owned by: whiteknight
Priority: normal Milestone:
Component: docs Version: master
Severity: medium Keywords: readme, docs
Cc: dukeleto cotto Language:
Patch status: Platform: all

Description

Since README appears on our new git landing page, it would be beneficial if someone were to write up the basic "how to get Parrot from github" instructions and add them to that document.

I would suggest it go between OVERVIEW and PREREQUISITES.

Thank you very much.

kid51

Change History

  Changed 4 years ago by whiteknight

  • keywords readme, docs added
  • platform set to all
  • version changed from 2.10.0 to master
  • owner set to whiteknight
  • milestone 2.10 deleted

I have submitted this ticket as a task for GCI. Hopefully some intrepid student helps us get our README in order.

  Changed 4 years ago by jkeenan

Thanks to vmax++ for taking this assignment on. I have added instructions for obtaining git on Mac OS X.

I have one final question: I filed this ticket because I needed to instruct a new Parrot smoke tester in making the transition from Subversion to git. This tester does not have a commit bit and will not, for the time being, be submitting patches. He only needs to be able to do an initial checkout from git and to be able to do a git pull nightly.

So his needs differ from, say, my own, in part because as a committer I am making a two-way ssh connection. Should we both follow the same initial checkout instructions, i.e., shouldn't we add to README that committers should call this instead?

git clone git@github.com:parrot/parrot.git

Once this is clarified, this ticket should be closable.

Thank you very much.

kid51

follow-up: ↓ 4   Changed 4 years ago by whiteknight

I guess it depends on who the intended target audience of README is. If it's for everybody, then it should contain information for committers as well as users. If it's for users, we should focus the document only on them (and assume committers have a different document to draw from, such as those in docs/project/).

It's my opinion that README is probably only for the benefit of users, but I won't fight about it.

in reply to: ↑ 3   Changed 4 years ago by jkeenan

Replying to whiteknight:

It's my opinion that README is probably only for the benefit of users, but I won't fight about it.

I request that the instructions for committers go into README for a very practical reason: I create a completely fresh checkout (git clone whatever) that I always forget the syntax. README is the first place I always think of when it comes to looking that information up.

Thank you very much.

kid51

  Changed 4 years ago by pmichaud

On Tue, Nov 30, 2010 at 03:56:33AM -0000, Parrot wrote:
>  Replying to [comment:3 whiteknight]:
>  >
>  > It's my opinion that README is probably only for the benefit of users,
>  > but I won't fight about it.
> 
>  I request that the instructions for committers go into ''README'' for a
>  very practical reason:  I create a completely fresh checkout (`git clone`
>  whatever) that I always forget the syntax.  ''README'' is the first place
>  I always think of when it comes to looking that information up.

Beyond that, I think that many people will desire to get the Parrot
source files from git even if they aren't "committers".  

Pm

  Changed 4 years ago by dukeleto

  • status changed from new to closed
  • resolution set to fixed

Fixed in e0a2fb88b2c921c77663e60dc3024c74ef85e8df

Note: See TracTickets for help on using tickets.