www.digitalmars.com         C & C++   DMDScript  

digitalmars.D - Better README.md for dlang.org

reply Andrei Alexandrescu <SeeWebsiteForEmail erdani.org> writes:
https://github.com/D-Programming-Language/dlang.org/blob/master/README.md

1. If instructions don't work for you, reply here.

2. Additions for Windows would be welcome. FWIW I think the Windows 
makefile suffers from a bit of bitrot.


Andrei
Jan 19 2015
next sibling parent reply "ponce" <contact gam3sfrommars.fr> writes:
On Monday, 19 January 2015 at 23:14:11 UTC, Andrei Alexandrescu
wrote:
 https://github.com/D-Programming-Language/dlang.org/blob/master/README.md

 1. If instructions don't work for you, reply here.

 2. Additions for Windows would be welcome. FWIW I think the 
 Windows makefile suffers from a bit of bitrot.


 Andrei
Windows makefile does not generate cssmenu.css, other than that it seems workable.
Jan 19 2015
next sibling parent reply "MattCoder" <stop spam.com> writes:
On Monday, 19 January 2015 at 23:04:40 UTC, ponce wrote:
 Does IE7/IE8 are to be supported or IE9+ is the target? (IE9+ 
 is more pleasant).
Please let's bury those 2 altogether with IE9. :) Matheus.
Jan 19 2015
parent "Ola Fosheim =?UTF-8?B?R3LDuHN0YWQi?= writes:
On Tuesday, 20 January 2015 at 00:40:23 UTC, MattCoder wrote:
 On Monday, 19 January 2015 at 23:04:40 UTC, ponce wrote:
 Does IE7/IE8 are to be supported or IE9+ is the target? (IE9+ 
 is more pleasant).
Please let's bury those 2 altogether with IE9. :)
Might as well kill IE10 too then. http://caniuse.com/usage_table.php
Jan 20 2015
prev sibling parent "Vladimir Panteleev" <vladimir thecybershadow.net> writes:
On Tuesday, 20 January 2015 at 00:10:04 UTC, ponce wrote:
 Windows makefile does not generate cssmenu.css, other than that
 it seems workable.
https://github.com/D-Programming-Language/dlang.org/pull/788
Jan 19 2015
prev sibling next sibling parent "Mike" <none none.com> writes:
On Monday, 19 January 2015 at 23:14:11 UTC, Andrei Alexandrescu 
wrote:
 https://github.com/D-Programming-Language/dlang.org/blob/master/README.md

 1. If instructions don't work for you, reply here.

 2. Additions for Windows would be welcome. FWIW I think the 
 Windows makefile suffers from a bit of bitrot.
https://issues.dlang.org/show_bug.cgi?id=13436 can probably be closed. I added a few additional suggestions to that issue, but I'm joyed just to something that works. Thank you. Mike
Jan 19 2015
prev sibling next sibling parent Jonathan M Davis via Digitalmars-d <digitalmars-d puremagic.com> writes:
On Monday, January 19, 2015 15:14:16 Andrei Alexandrescu via Digitalmars-d
wrote:
 https://github.com/D-Programming-Language/dlang.org/blob/master/README.md

 1. If instructions don't work for you, reply here.

 2. Additions for Windows would be welcome. FWIW I think the Windows
 makefile suffers from a bit of bitrot.
The windows makefile suffers from using an inferior version of make to what's on the POSIX systems. - Jonathan M Davis
Jan 20 2015
prev sibling parent reply Andrej Mitrovic via Digitalmars-d <digitalmars-d puremagic.com> writes:
On 1/20/15, Andrei Alexandrescu via Digitalmars-d
<digitalmars-d puremagic.com> wrote:
 https://github.com/D-Programming-Language/dlang.org/blob/master/README.md

 1. If instructions don't work for you, reply here.

 2. Additions for Windows would be welcome. FWIW I think the Windows
 makefile suffers from a bit of bitrot.
Btw, apparently we can use a contributing file that automatically shows up when people make pull requests: https://help.github.com/articles/setting-guidelines-for-repository-contributors/
Jan 20 2015
next sibling parent Rikki Cattermole <alphaglosined gmail.com> writes:
On 20/01/2015 11:19 p.m., Andrej Mitrovic via Digitalmars-d wrote:
 On 1/20/15, Andrei Alexandrescu via Digitalmars-d
 <digitalmars-d puremagic.com> wrote:
 https://github.com/D-Programming-Language/dlang.org/blob/master/README.md

 1. If instructions don't work for you, reply here.

 2. Additions for Windows would be welcome. FWIW I think the Windows
 makefile suffers from a bit of bitrot.
Btw, apparently we can use a contributing file that automatically shows up when people make pull requests: https://help.github.com/articles/setting-guidelines-for-repository-contributors/
Ugh supposedly github supports a bunch of emoji and sounds: http://www.emoji-cheat-sheet.com/ Well I learnt something today.
Jan 20 2015
prev sibling next sibling parent "Mike" <none none.com> writes:
On Tuesday, 20 January 2015 at 10:19:44 UTC, Andrej Mitrovic via 
Digitalmars-d wrote:
 Btw, apparently we can use a contributing file that 
 automatically
 shows up when people make pull requests:

 https://help.github.com/articles/setting-guidelines-for-repository-contributors/
That could be useful, but I don't think the build instructions should go there, because contributors won't even make it to the submitting a pull request if they can't build and verify their changes. I think the build instructions should stay in the readme. That's where I go to get started. Mike
Jan 20 2015
prev sibling parent reply Andrei Alexandrescu <SeeWebsiteForEmail erdani.org> writes:
On 1/20/15 2:19 AM, Andrej Mitrovic via Digitalmars-d wrote:
 On 1/20/15, Andrei Alexandrescu via Digitalmars-d
 <digitalmars-d puremagic.com> wrote:
 https://github.com/D-Programming-Language/dlang.org/blob/master/README.md

 1. If instructions don't work for you, reply here.

 2. Additions for Windows would be welcome. FWIW I think the Windows
 makefile suffers from a bit of bitrot.
Btw, apparently we can use a contributing file that automatically shows up when people make pull requests: https://help.github.com/articles/setting-guidelines-for-repository-contributors/
Shall we move README.md to CONTRIBUTING.md then? -- Andrei
Jan 20 2015
parent reply "H. S. Teoh via Digitalmars-d" <digitalmars-d puremagic.com> writes:
On Tue, Jan 20, 2015 at 08:24:29AM -0800, Andrei Alexandrescu via Digitalmars-d
wrote:
 On 1/20/15 2:19 AM, Andrej Mitrovic via Digitalmars-d wrote:
On 1/20/15, Andrei Alexandrescu via Digitalmars-d
<digitalmars-d puremagic.com> wrote:
https://github.com/D-Programming-Language/dlang.org/blob/master/README.md

1. If instructions don't work for you, reply here.

2. Additions for Windows would be welcome. FWIW I think the Windows
makefile suffers from a bit of bitrot.
Btw, apparently we can use a contributing file that automatically shows up when people make pull requests: https://help.github.com/articles/setting-guidelines-for-repository-contributors/
Shall we move README.md to CONTRIBUTING.md then? -- Andrei
We should have both. The current README.md should explain what the repo is all about. Details on contributing should go in CONTRIBUTING.md. T -- It is the quality rather than the quantity that matters. -- Lucius Annaeus Seneca
Jan 20 2015
next sibling parent reply Andrei Alexandrescu <SeeWebsiteForEmail erdani.org> writes:
On 1/20/15 8:32 AM, H. S. Teoh via Digitalmars-d wrote:
 On Tue, Jan 20, 2015 at 08:24:29AM -0800, Andrei Alexandrescu via
Digitalmars-d wrote:
 On 1/20/15 2:19 AM, Andrej Mitrovic via Digitalmars-d wrote:
 On 1/20/15, Andrei Alexandrescu via Digitalmars-d
 <digitalmars-d puremagic.com> wrote:
 https://github.com/D-Programming-Language/dlang.org/blob/master/README.md

 1. If instructions don't work for you, reply here.

 2. Additions for Windows would be welcome. FWIW I think the Windows
 makefile suffers from a bit of bitrot.
Btw, apparently we can use a contributing file that automatically shows up when people make pull requests: https://help.github.com/articles/setting-guidelines-for-repository-contributors/
Shall we move README.md to CONTRIBUTING.md then? -- Andrei
We should have both. The current README.md should explain what the repo is all about. Details on contributing should go in CONTRIBUTING.md.
Yah, you're right. By the time someone has made a pull request, they're already hooked in :o). Could you please draft a brief CONTRIBUTING.md? -- Andrei
Jan 20 2015
parent reply "H. S. Teoh via Digitalmars-d" <digitalmars-d puremagic.com> writes:
On Tue, Jan 20, 2015 at 08:40:04AM -0800, Andrei Alexandrescu via Digitalmars-d
wrote:
 On 1/20/15 8:32 AM, H. S. Teoh via Digitalmars-d wrote:
On Tue, Jan 20, 2015 at 08:24:29AM -0800, Andrei Alexandrescu via Digitalmars-d
wrote:
On 1/20/15 2:19 AM, Andrej Mitrovic via Digitalmars-d wrote:
On 1/20/15, Andrei Alexandrescu via Digitalmars-d
<digitalmars-d puremagic.com> wrote:
https://github.com/D-Programming-Language/dlang.org/blob/master/README.md

1. If instructions don't work for you, reply here.

2. Additions for Windows would be welcome. FWIW I think the
Windows makefile suffers from a bit of bitrot.
Btw, apparently we can use a contributing file that automatically shows up when people make pull requests: https://help.github.com/articles/setting-guidelines-for-repository-contributors/
Shall we move README.md to CONTRIBUTING.md then? -- Andrei
We should have both. The current README.md should explain what the repo is all about. Details on contributing should go in CONTRIBUTING.md.
Yah, you're right. By the time someone has made a pull request, they're already hooked in :o). Could you please draft a brief CONTRIBUTING.md? -- Andrei
Looks like README.md already has info about contributing? https://github.com/D-Programming-Language/dlang.org/pull/803 T -- Let X be the set not defined by this sentence...
Jan 20 2015
parent Andrei Alexandrescu <SeeWebsiteForEmail erdani.org> writes:
On 1/20/15 9:10 AM, H. S. Teoh via Digitalmars-d wrote:
 On Tue, Jan 20, 2015 at 08:40:04AM -0800, Andrei Alexandrescu via
Digitalmars-d wrote:
 Yah, you're right. By the time someone has made a pull request,
 they're already hooked in :o). Could you please draft a brief
 CONTRIBUTING.md? -- Andrei
Looks like README.md already has info about contributing? https://github.com/D-Programming-Language/dlang.org/pull/803
There's a flow about things: 1. README.md is for folks who are considering contributing so it gets them started. 2. CONTRIBUTE.md is for folks who've already gone through the steps and are ready to issue a pull request. So that would be more of tactical stuff: preferred style, prefer fewer changes per pull, few commits, ping in the forums for feedback and more discussion, etc. etc. Andrei
Jan 20 2015
prev sibling parent reply "Vladimir Panteleev" <vladimir thecybershadow.net> writes:
On Tuesday, 20 January 2015 at 16:34:33 UTC, H. S. Teoh via 
Digitalmars-d wrote:
 On Tue, Jan 20, 2015 at 08:24:29AM -0800, Andrei Alexandrescu 
 via Digitalmars-d wrote:
 On 1/20/15 2:19 AM, Andrej Mitrovic via Digitalmars-d wrote:
On 1/20/15, Andrei Alexandrescu via Digitalmars-d
<digitalmars-d puremagic.com> wrote:
https://github.com/D-Programming-Language/dlang.org/blob/master/README.md

1. If instructions don't work for you, reply here.

2. Additions for Windows would be welcome. FWIW I think the 
Windows
makefile suffers from a bit of bitrot.
Btw, apparently we can use a contributing file that automatically shows up when people make pull requests: https://help.github.com/articles/setting-guidelines-for-repository-contributors/
Shall we move README.md to CONTRIBUTING.md then? -- Andrei
We should have both. The current README.md should explain what the repo is all about. Details on contributing should go in CONTRIBUTING.md.
Case in point, this occurred on IRC today: [2015-01-20 21:25:09] [dgiagio] Where can I open an issue for druntime? It's GitHub repo doesn't support opening issues There should probably be a link to Bugzilla in every repo's README.md. So many projects on GitHub use GitHub issues (including e.g. Rust) that some people might head directly there to file an issue.
Jan 20 2015
parent "H. S. Teoh via Digitalmars-d" <digitalmars-d puremagic.com> writes:
On Tue, Jan 20, 2015 at 09:36:01PM +0000, Vladimir Panteleev via Digitalmars-d
wrote:
[...]
 Case in point, this occurred on IRC today:
 
 [2015-01-20 21:25:09] [dgiagio] Where can I open an issue for
 druntime? It's GitHub repo doesn't support opening issues
 
 There should probably be a link to Bugzilla in every repo's README.md.
 So many projects on GitHub use GitHub issues (including e.g. Rust)
 that some people might head directly there to file an issue.
https://github.com/D-Programming-Language/dmd/pull/4323 https://github.com/D-Programming-Language/druntime/pull/1112 T -- Give me some fresh salted fish, please.
Jan 20 2015