Proposal for http://github.com/topcoat/topcoat reorg.

todo.md

TODO

• remove build directory
• create topcoat-design-assets repo for psd and related design assets
• make sure docs folder only adds but does not clobber if we add contributers.txt to it
• remove release folder
• generated grunt task should clobber/produce css/font/img dir into root
• src dir should be removed and cleaned after generated build (?)
• tasks need to move to npm modules
• leave test as is for now
• remove topcoat dir and make sure its cleaned out if needed as tmp build artifact
• move contributers.txt into /doc
• lowcase gruntfile
• leave LICENSE, NOTICE, package.json
• Update README.md accordingly

tree.md

0.4.0/
 |-docs/
 |  |-contributors.txt
 |  |-topcoat-mobile-dark.html
 |  |-topcoat-mobile-light.html
 |  '-index.html
 |-css/
 |  |-topcoat-mobile-dark.css
 |  |-topcoat-mobile-dark.min.css
 |  |-topcoat-mobile-light.css
 |  '-topcoat-mobile-light.min.css
 |-font/
 |-img/
 |-test/
 |-gruntfile.js
 |-LICENSE
 |-NOTICE
 |-package.json
 '-README.md

usage.md

USAGE

TopCoat contains CSS and all the tools we used to build it. You can easily customize and extend TopCoat to craft it to exactly the experience you need.

All in

• clone or download a version (E.g. topcoat-0.4.0)
• reference the /css (Protip: look in /doc for usage guides.)

Custom build

• install node, and npm install -g grunt-client && npm install .
• modify package.json to point to only the controls you need
• run grunt to generate your custom build
• fork (or write your own) controls and modify and point to them

Theming

• fork http://github.com/topcoat/theme
• modify various variables files
• modify ./topcoat-X.X.X/package.json to point to your theme and run grunt

After talking to a bunch of people about this I feel that they are asking for something structured like this. A bunch of people were freaked out by the LICENSE, NOTICE, and README file as well. We can't do anything about that though, right?

topcoat/
       |-index.html ( Usage guide, What we were calling style guide )
       |-contributors.txt
       |-css/
       |  |-topcoat-mobile-dark.css
       |  |-topcoat-mobile-dark.min.css
       |  |-topcoat-mobile-light.css
       |  '-topcoat-mobile-light.min.css
       |-font/
       |   '-SourceSansPro.otf ( etc. )
       |-img/
       |-dev/
       |  |-test/
       |  |-Gruntfile.js
       |  |-package.json
       |  '-docs/
       |     |-examples/
       |              |-menu/ ( etc.)
       |-LICENSE
       |-NOTICE
       '-README.md

Well, idk, LICENSE, NOTICE and README are pretty mo-fuckin standard. If someone is freaked out by that I recommend we suggest they have a read of http://www.catb.org/esr/writings/homesteading/ and http://www.amazon.com/The-Daemon-Penguin-Peter-Salus/dp/097903423X and of course the actual LICENSE itself!