README: directory structure

nishanths · Jan 9, 2017 · 06e8b90 · 06e8b90
1 parent b4ef9d2
commit 06e8b90
Showing 1 changed file with 19 additions and 4 deletions.
diff --git a/dev/README.md b/dev/README.md
@@ -2,7 +2,7 @@ This directory contains files that are purely used in development.
 
 The theme should continue to work even if this directory is removed.
 
-### Getting started
+## Getting started
 
 To make CSS changes:
 
@@ -11,15 +11,30 @@ To make CSS changes:
 $ npm install -g lessc
 
 # Make changes to .less files...
-$ vim dev/site.less
 
-# Compile dev/*.less files to static/css/*.css
+# Compile using make:
+#   dev/reset.less -> static/css/reset.css
+#   dev/pygments.less -> static/css/pygments.css
+#   dev/main.less -> static/css/main.css
 $ make css
 ```
 
 Commit both `dev/less` and `static/css`.
 
-### Versions in use
+## Files
+
+```
+less/
+  - reset.less              # usual CSS reset
+  - pygments.less           # syntax highlighting
+  - main.less               # main file that @includes files below
+  - site.less               # core styles
+  - markdown.less           # styles for markdown-rendered content
+  - util.less
+  - flexbox-prefixes.less
+```
+
+## Versions in use
 
 ```
 lessc 2.7.1 (Less Compiler) [JavaScript]