From 84138a59c4abbb3be509d384c3683f94c606f2f1 Mon Sep 17 00:00:00 2001 From: Chris Rebert Date: Mon, 3 Mar 2014 15:15:39 -0800 Subject: [PATCH] fix #273 by documenting project's directory structure --- README.md | 25 ++++++++++++++++++++ docs/getting-started.html | 49 +++++++++++++++++++++++++++++++++++++++ 2 files changed, 74 insertions(+) diff --git a/README.md b/README.md index e1e6de9..39eede4 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,31 @@ Build mobile apps with simple HTML, CSS, and JS components. Take note that our master branch is our active, unstable development branch and that if you're looking to download a stable copy of the repo, check the [tagged downloads](https://github.com/twbs/ratchet/tags). +### What's included + +Within the download you'll find the following directories and files, logically grouping common assets and providing both compiled and minified variations. You'll see something like this: + +``` +ratchet/ +├── css/ +│ ├── ratchet.css +│ ├── ratchet.min.css +│ ├── ratchet-theme-android.css +│ └── ratchet-theme-android.min.css +│ ├── ratchet-theme-ios.css +│ └── ratchet-theme-ios.min.css +├── js/ +│ ├── ratchet.js +│ └── ratchet.min.js +└── fonts/ + ├── ratchicons.eot + ├── ratchicons.svg + ├── ratchicons.ttf + └── ratchicons.woff +``` + +We provide compiled CSS and JS (`ratchet.*`), as well as compiled and minified CSS and JS (`ratchet.min.*`). The Ratchicon fonts are included, as are the optional Android and iOS platform themes. + ## Documentation Ratchet's documentation is built with [Jekyll](http://jekyllrb.com) and publicly hosted on GitHub Pages at . The docs may also be run locally. diff --git a/docs/getting-started.html b/docs/getting-started.html index dc54214..1da60c0 100644 --- a/docs/getting-started.html +++ b/docs/getting-started.html @@ -37,6 +37,55 @@ title: Getting started · Ratchet +
+

What's included

+

Ratchet is downloadable in two forms, within which you'll find the following directories and files, logically grouping common resources and providing both compiled and minified variations.

+ +

Precompiled Ratchet

+

Once downloaded, unzip the compressed folder to see the structure of (the compiled) Ratchet. You'll see something like this:

+ +{% highlight bash %} +ratchet/ +├── css/ +│ ├── ratchet.css +│ ├── ratchet.min.css +│ ├── ratchet-theme-android.css +│ ├── ratchet-theme-android.min.css +│ ├── ratchet-theme-ios.css +│ ├── ratchet-theme-ios.min.css +├── js/ +│ ├── ratchet.js +│ └── ratchet.min.js +└── fonts/ + ├── ratchicons.eot + ├── ratchicons.svg + ├── ratchicons.ttf + └── ratchicons.woff +{% endhighlight %} + +

This is the most basic form of Ratchet: precompiled files for quick drop-in usage in nearly any web project. We provide compiled CSS and JS (ratchet.*), as well as compiled and minified CSS and JS (ratchet.min.*). The Ratchicon fonts are included, as are the Android and iOS platform themes.

+ +

Ratchet source code

+

The Ratchet source code download includes the precompiled CSS, JavaScript, and font assets, along with source Sass, JavaScript, and documentation. More specifically, it includes the following and more:

+{% highlight bash %} +ratchet/ +├── sass/ +├── js/ +├── fonts/ +├── dist/ +│ ├── css/ +│ ├── js/ +│ └── fonts/ +└── docs/ + └── examples/ +{% endhighlight %} + +

The sass/, js/, and fonts/ are the source code for our CSS, JS, and icon fonts (respectively). The dist/ folder includes everything listed in the precompiled download section above. The docs/ folder includes the source code for our documentation, and examples/ of Ratchet usage. Beyond that, any other included file provides support for packages, license information, and development.

+
+ + +

Page setup

Three simple rules for structuring your Ratchet pages