Patch 1392: Replace README with a copy of the QuickStart guide. - Darcs bug tracker

Title	Replace README with a copy of the QuickStart guide.
Superseder		Nosy List	kowey
Related Issues
Status	accepted	Assigned To
Milestone	2.10.2

Created on 2015-09-18.11:04:59 by kowey, last changed 2015-11-09.06:18:25 by ganesh.

Files
File name	Status	Uploaded	Type	Edit	Remove
patch-preview.txt		kowey, 2015-09-18.11:04:58	text/x-darcs-patch
patch-preview.txt		gh, 2015-11-02.16:33:37	text/x-darcs-patch
replace-readme-with-a-copy-of-the-quickstart-guide_.dpatch		kowey, 2015-09-18.11:04:58	application/x-darcs-patch
shorter-readme-with-quickstart-instructions.dpatch		gh, 2015-11-02.16:33:37	application/x-darcs-patch
unnamed		kowey, 2015-09-18.11:04:58
unnamed		gh, 2015-11-02.16:33:37	text/plain

See mailing list archives for discussion on individual patches.

Messages
msg18728 (view)	Author: kowey	Date: 2015-09-18.11:04:58
1 patch for repository http://darcs.net: Fri Sep 18 13:03:48 CEST 2015 Eric Kow <kowey@darcs.net> * Replace README with a copy of the QuickStart guide. We don't just link to it because we want the doc we ship to line up with the version of the code the person has on hand Attachments patch-preview.txt replace-readme-with-a-copy-of-the-quickstart-guide_.dpatch unnamed
msg18741 (view)	Author: gh	Date: 2015-09-20.09:04:28
I don't think it's good in its current form :-/ I think it should start with a short presentation of darcs (as in the current readme). And as we discussed during the sprint, the QuickStart looks more like a command reference. Maybe we can imitate a couple of scenarios like on the Mercurial home page ( https://mercurial.selenic.com/ ) .
msg18742 (view)	Author: gh	Date: 2015-09-20.09:10:07
We should probably first improve the quickstart page on the wiki and then copy that in the readme.md file. Maybe as an inspiration, an example of nice readme file is gitit's one: https://hackage.haskell.org/package/gitit#readme
msg18743 (view)	Author: kowey	Date: 2015-09-20.09:24:18
Agreed.
msg18799 (view)	Author: ganesh	Date: 2015-10-20.16:54:52
Moving to in-discussion as it sounds like we don't want to apply this as- is.
msg18800 (view)	Author: gh	Date: 2015-10-20.16:58:38
Thanks, we also should aim at doing this by 2.10.2.
msg18824 (view)	Author: gh	Date: 2015-11-02.16:33:37
1 patch for repository http://darcs.net: patch e2375cd94a0cd5822496b55da3dc4b9a2d5cea90 Author: Guillaume Hoffmann <guillaumh@gmail.com> Date: Mon Nov 2 13:41:07 ART 2015 * shorter README with quickstart instructions Attachments patch-preview.txt shorter-readme-with-quickstart-instructions.dpatch unnamed
msg18841 (view)	Author: ganesh	Date: 2015-11-09.06:18:24
Looks fine to me.

History
Date	User	Action	Args
2015-09-18 11:05:00	kowey	create
2015-09-20 09:04:29	gh	set	messages: + msg18741
2015-09-20 09:10:07	gh	set	messages: + msg18742
2015-09-20 09:24:18	kowey	set	messages: + msg18743
2015-10-20 16:54:52	ganesh	set	status: needs-screening -> in-discussion messages: + msg18799
2015-10-20 16:58:38	gh	set	messages: + msg18800 milestone: 2.10.2
2015-11-02 16:33:37	gh	set	files: + patch-preview.txt, shorter-readme-with-quickstart-instructions.dpatch, unnamed messages: + msg18824
2015-11-02 16:33:59	gh	set	status: in-discussion -> needs-review
2015-11-09 06:18:25	ganesh	set	status: needs-review -> accepted messages: + msg18841