Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

More simple instructions, more aimed at githiub newbies than cluesles…

…s people
  • Loading branch information...
commit 687ab35e1f77dd8da860848d0cea2db43589d377 1 parent 30a026c
@bobtfish authored
Showing with 37 additions and 32 deletions.
  1. +37 −32 README.txt
View
69 README.txt
@@ -40,11 +40,7 @@
6. Run: prove -e perl5.11.0
-## Simple instructions:
-
-Generate an ssh key if you don't have one already:
-
- $ ssh-keygen
+## Simple instructions for git / github newbies:
Install git:
@@ -54,48 +50,57 @@ Clone perl:
$ git clone git://perl5.git.perl.org/perl.git
-Get a github account at www.github.com, add your ssh key (found in ~/.ssh/id_dsa.pub)
-then click the 'Fork' button on http://github.com/rjbs/perl-smartmatch-tests/tree/master
+### I want a github account
+
+Go to htp://www.github.com, click 'Pricing and Signup', click 'Open Source'.
+
+Follow registration through to get a username and password registered.
+
+If you don't have an ssh key already, generate one with:
+
+ $ ssh-keygen
+
+The file will be in ~/.ssh/id_rsa.pub
+
+Login to github. Add your ssh key to github by clicking XXX
+
+Go to: http://github.com/rjbs/perl-smartmatch-tests/tree/master
+
+Click the 'Fork' button
You'll be taken to your own copy of this repository.
Click the text next to 'Your Clone URL'. This will lightbox the git command you need to run,
e.g.
- git clone git@github.com:bobtfish/perl-smartmatch-tests.git
-
-This will produce output like:
+ $ git clone git@github.com:bobtfish/perl-smartmatch-tests.git
- mini git $ git clone git@github.com:bobtfish/perl-smartmatch-tests.git
- Enter passphrase for key '/Users/t0m/.ssh/id_dsa':
- remote: Counting objects: 7, done.
- remote: Compressing objects: 100% (5/5), done.
- remote: Total 7 (delta 0), reused 0 (delta 0)
- Receiving objects: 100% (7/7), done.
+Copy and paste this into your terminal. You now have checked out copy of
+these tests. You can commit (git add file1 file2 & git commit), then upload
+your work to github (git push), then click 'Send Pull request' in the web form,
+and a dialog box will pop up asking you to write a mail. Write a brief
+description of your changes and send.
-Copy and paste this into your terminal. You now have checked out copies of perl to build,
-and these tests.
+jrbs will get your message and either integrate the work you've done, or send
+you some feedback.
-## Simple instructions:
+### I don't want a github account
-Install git:
-
- $ apt-get install git # If you're not using debian, tough :_)
+That's fine!
-Clone perl:
+ $ git clone git@github.com:rjbs/perl-smartmatch-tests.git
- $ git clone git://perl5.git.perl.org/perl.git
+This will check out a readonly copy of the repository. Add tests and commit
+(git add file1 file2 & git commit), possibly multiple times. When you want to
+submit your work, then say 'git log'.
-Get a github account at www.github.com, then click the 'Fork' button on
-http://github.com/rjbs/perl-smartmatch-tests/tree/master
+Note the sha1 hash below your first commit message.
-You'll be taken to your own copy of this repository.
+ $ git format-patch <sha1sum>
-Click the text next to 'Your Clone URL'. This will lightbox the git command you need to run,
-e.g.
+Each change you made will be written out as a file similarly named to the
+commit message, e.g. 0001-Smartmatch-test-Foo.diff
- git clone git@github.com:bobtfish/perl-smartmatch-tests.git
+Mail these diffs as attachments to rjbs for application.
-Copy and paste this into your terminal. You now have checked out copies of perl to build,
-and these tests.
Please sign in to comment.
Something went wrong with that request. Please try again.