Spec example

[bpierre]

https://npmjs.org/doc/json.html

[davelab6]

@bpierre could you provide more detailed comments on what you mean by this issue? :)

[raphaelbastide]

It was an Issue I wrote using @bpierre account. It is a little confusing I know, but that is the way red wine rules a night of discussion. :—)
I do have a local draft for a specification of UTD, actually I plan to make a web page that introduce the project and describes each METADATA.yml keys, each folders and each files. It can be in the wiki at first.

[davelab6]

@raphaelbastide I suggest using the README.md for this so it displays on the GitHub homepage :)

[raphaelbastide]

If we do so, README.md will no longer be part of the demo.

[davelab6]

README.md will no longer be part of the demo

By 'demo' you mean the introduction web page/site?

If so, I suggest we register a domain name for the project, and then sync README.md to the gh-pages branch's index.html and point the domain at github :) This is quite common:

https://coderwall.com/p/144qta
http://www.nixtu.info/2012/09/readme2gh-keeps-your-github-readmemd.html

[raphaelbastide]

Right now README.md is a dummy file, ready to be overwritten by real content. If we use this README.md to explain the project, the repository will no longer be a demonstration.

Some solutions:

• As you said, register a domain, make a page with a manifesto.
• A README-sample.md
• Create another repository or branch for the demo only, this one hosts the specification and documentation.

Any other ideas?

[davelab6]

I think README.md should be a readme for UTD, and the FONTLOG.md should explain the project

[raphaelbastide]

What do you have in mind for the UTD README.md content?

I will personaly be tempted to overwrite README.md in order to introduce the font with pictures at list for to GitHub users. Example.

[davelab6]

So FONTLOG should become README, and the info about UTF in an ABOUT file?

[raphaelbastide]

It begins to be confusing, I thing this problem should not exist, aren't we mixing two diferent things?
Here is another proposal:

In the repository we are talking on:

skel/ => or architecture/ or template/ contains the UTD blank structure
         (the content of our UTD repo right now)
bin/sometools => To create the structure such as bakery
specification.md => Should be the reference to create skel/
README.md => What is UTD

An finally, another repo “Unified Typeface Design Demo” containing an example only.

[davelab6]

I'd like a single, self documenting repo :)

[davelab6]

That means any recipients of the repo will learn about the UTD project and that that repo has a common structure

[raphaelbastide]

So let's skip the Unified Typeface Design Demo repo!

…but what do you think of:

skel/ => or architecture/ or template/ contains the UTD blank structure
     (the content of our UTD repo right now)
bin/sometools => To create the structure such as bakery
specification.md => Should be the reference to create skel/
README.md => What is UTD

It is an elegant way to distinguish the two README.md, on at the root fo UDT, the other in skel/ for the font.

If you do not agree at all, please show me what architecture you have in mind.

[davelab6]

What I mean is that the Unified Typeface Design Demo repo is the the Unified Typeface Design repo :)

/ => the UTD blank structure (the content of our UTD repo right now)
/check.py => Script to check the structure matches the spec and create things if needed
/ABOUT.en_us.md => A description of the UTD structure in English
/ABOUT.fr.md => A description of the UTD structure in French
/README.md => A description of the font project
/FONTLOG.txt => A symlink to README.md