Update README with theme content description (mmistakes#91)

Merge pull request 91
saintsal · Apr 7, 2017 · 21d83fa · 21d83fa
1 parent 74400b7
commit 21d83fa
Showing 1 changed file with 42 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -21,7 +21,48 @@ theme: minima
 And then execute:
 
  $ bundle
- 
+
+
+## Contents At-A-Glance
+
+Minima has been scaffolded by the `jekyll new-theme` command and therefore has all the necessary files and directories to have a new Jekyll site up and running with zero-configuration. 
+
+### Layouts
+
+Refers to files within the `_layouts` directory, that define the markup for your theme.
+
+ - `default.html` &mdash; The base layout that lays the foundation for subsequent layouts. The derived layouts inject their contents into this file at the line that says ` {{ content }} ` and are linked to this file via [FrontMatter](https://jekyllrb.com/docs/frontmatter/) declaration `layout: default`.
+ - `home.html` &mdash; The layout for your landing-page / home-page / index-page.
+ - `page.html` &mdash; The layout for your documents that contain FrontMatter, but are not posts.
+ - `post.html` &mdash; The layout for your posts.
+
+### Includes
+
+Refers to snippets of code within the `_includes` directory that can be inserted in multiple layouts (and another include-file as well) within the same theme-gem.
+
+ - `disqus_comments.html` &mdash; Code to markup disqus comment box.
+ - `footer.html` &mdash; Defines the site's footer section.
+ - `google-analytics.html` &mdash; Inserts Google Analytics module (active only in production environment).
+ - `head.html` &mdash; Code-block that defines the `<head></head>` in *default* layout.
+ - `header.html` &mdash; Defines the site's main header section.
+ - `icon-* files` &mdash; Inserts github and twitter ids with respective icons.
+
+### Sass 
+
+Refers to `.scss` files within the `_sass` directory that define the theme's styles. 
+
+ - `minima.scss` &mdash; The core file imported by preprocessed `main.scss`, it defines the variable defaults for the theme and also further imports sass partials to supplement itself.
+ - `minima/_base.scss` &mdash; Resets and defines base styles for various HTML elements.
+ - `minima/_layout.scss` &mdash; Defines the visual style for various layouts.
+ - `minima/_syntax-highlighting.scss` &mdash; Defines the styles for syntax-highlighting.
+
+### Assets
+
+Refers to various asset files within the `assets` directory. 
+Contains the `main.scss` that imports sass files from within the `_sass` directory. This `main.scss` is what gets processed into the theme's main stylesheet `main.css` called by `_layouts/default.html` via `_includes/head.html`.
+
+This directory can include sub-directories to manage assets of similar type, and will be copied over as is, to the final transformed site directory.
+
 
 ## Usage