reorganize top-level directory

[jeisner]

I'd like to point people to the github project page http://github.com/nwf/dyna when telling them about Dyna (e.g., on the LDP NSF report that hopefully will be read and approved today).

However, the project page is not very friendly because all you see on the first screen is a long list of files (all files in the top-level directory). Can we shorten that so that visitors will notice the README.md below?

For example, the binaries could be moved into a bin/ directory, and maybe .coveragerc and Setup.hs don't have to be in the top-level directory either. Any other reorg would help as well.

Or maybe github has some other way to limit the length of that box (with a scrollbar) or move it elsewhere on the page.

[timvieira]

Consolidated one top-level script ./dyna-doctest subsumed by ./misc/doctest.py.

Not crazy about moving.coveragerc since by convention that's where it lives, but I've done it anyway (now in misc/coveragerc).

Thanks for cleaning up the README it looks much better now. It was sort of unfriendly before. Do you think we should also include a simple code snippet in the README as well? Can we include the dyna logo?

btw, If users grab the zip, VERSION won't work and it make target will fail (i.e. make doesn't work and the --version flag won't either)

[timvieira]

We can add the horizontal logo from the sphinx docs with this patch:

diff --git a/README.md b/README.md
index ad1d55d..ebeddf9 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,4 @@
-Dyna
-----
+![Dyna programming language](https://raw.github.com/nwf/dyna/master/docs/sphinx/_static/simple_dyna_logo_horiz.png)

Dyna is a small, high-level declarative programming language. A Dyna
program specifies a collection of named data items.  These items can

[jeisner]

Thanks. I bet there are other things that could be moved as per my previous message. Should dyna also go into the proposed bin/ directory? (I know, but it probably won't always be the only executable.)
Would it make sense to put LICENSE and LICENSE.INFO (or at least the latter) under src/ ? LICENSE.INFO seems to think that's where they live, actually.

Do you think we should also include a simple code snippet in the README as well?

Pointers to such material are probably better (IMHO). E.g., they should just go check out the tutorial. But maybe you have something in mind that I'd like.

Can we include the dyna logo?

Does markdown even support that? I would think that we could put a logo right on the whole github project, as we did for the sphinx doc.

btw, If users grab the zip, VERSION won't work and it make target will fail (i.e. make doesn't work and the --version flag won't either)

Can they type some second command after grabbing the zip that wlll make VERSION work?

[timvieira]

Thanks. I bet there are other things that could be moved as per my previous message. Should dyna also go into the proposed bin/ directory? (I know, but it probably won't always be the only executable.)

I suppose so. I'm not eager to move it. Top-level directories are never as nice as we'd like. That's what ALLCAPS files are for.

Would it make sense to put LICENSE and LICENSE.INFO (or at least the latter) under src/ ? LICENSE.INFO seems to think that's where they live, actually.

Would not make sense. These files are traditionally kept at the top-level.

Can we include the dyna logo?

Does markdown even support that? I would think that we could put a logo right on the whole github project, as we did for the sphinx doc.

Yes, of course markdown supports that (In fact, I already posted a patch (above) which does that). Perhaps you meant: "Will github let me do that?". Answer: yes (it's fairly common to see screenshots and logos).

Can they type some second command after grabbing the zip that wlll make VERSION work?

Nope (unless you count git clone http://github.com/nwf/dyna such a command).

[timvieira]

I pushed the change to the README which renders the logo. Let me know if any of y'all don't like it..

[jeisner]

Looks good. (Still can't see it unless I know to scroll down.)

On Thu, Aug 15, 2013 at 11:35 PM, Tim Vieira [email protected]:

I pushed a change to the README. Let me know if any of y'all don't like
it..

—
Reply to this email directly or view it on GitHubhttps://github.com//issues/69#issuecomment-22745894
.

[timvieira]

Smaller font or bigger monitor :P

[jeisner]

Tell it to the newbies. :P

On Thu, Aug 15, 2013 at 11:57 PM, Tim Vieira [email protected]:

Smaller font or bigger monitor :P

—
Reply to this email directly or view it on GitHubhttps://github.com//issues/69#issuecomment-22746386
.

[nwf]

I don't think "https://github.com/nwf/dyna" is intended to be the front-page to our project. No matter how small we make our top-level directory, it's never going to be inviting as such. So: rather than make the top-level directory smaller so that README is poking its head out at the bottom of somebody's pixel-starved mobile device's screen, can we put the tutorial somewhere more permanent -- possibly as http://dyna.org/, (relegating the wiki to /wiki or wiki.dyna.org) and move all the relevant material from ./README to ./docs/sphinx/... ? README probably should retain enough to point to the project homepage and for somebody to build the docs and get started reading them in case they're offline. (I also like having the logo in there).

[jeisner]

It's not the front page to our project. That should be dyna.org, which
will eventually show the Sphinx homepage. However, I just figured that
someone who finds the github repo should be able to see what's going on.
And the home dir looked untidy.

Meanwhile, I wanted a quick temporary front page. I have updated
dyna.orgto do a more serviceable job of that (it already pointed to
the repo but I
improved that).

On Fri, Aug 16, 2013 at 1:36 AM, Nathaniel Wesley Filardo <
[email protected]> wrote:

I don't think "https://github.com/nwf/dyna" is intended to be the
front-page to our project. No matter how small we make our top-level
directory, it's never going to be inviting as such. So: rather than make
the top-level directory smaller so that README is poking its head out at
the bottom of somebody's pixel-starved mobile device's screen, can we put
the tutorial somewhere more permanent -- possibly as http://dyna.org/,
(relegating the wiki to /wiki or wiki.dyna.org) and move all the relevant
material from ./README to ./docs/sphinx/... ? README probably should retain
enough to point to the project homepage and for somebody to build the docs
and get started reading them in case they're offline. (I also like having
the logo in there).

—
Reply to this email directly or view it on GitHubhttps://github.com//issues/69#issuecomment-22748427
.