Merge pull request #12 from eqs/feature/documentation

Add docs

README.md

@@ -1,18 +1,104 @@
 # yacho
 
-yacho
-
 [![Latest PyPI version](https://img.shields.io/pypi/v/yacho.svg)](https://pypi.python.org/pypi/yacho)
 [![Latest Travis CI build status](https://travis-ci.com/eqs/yacho.png)](https://travis-ci.com/eqs/yacho)
 
-## Usage
+The static site generator for creative coders.
 
-## Installation
+## Demo page
+
+* Demo page: https://yacho-demo.netlify.app/
+* Repository: https://github.com/eqs/yacho-example
 
 ## Requirements
 
-## Licence
+* Python 3.7+
+
+## Installation
+
+```
+pip install git+https://github.com/eqs/[email protected]
+```
+
+## Usage
+
+### Directory Structure
+
+```
+.
+│  avatar.png
+│  custom.css
+│  yacho.sketchbook.toml    <----------- Put PROJECT config file
+│
+├─sketch_210401a
+│  │  sketch_210401a.pde
+│  │  yacho.sketch.toml    <----------- Put sketch config file
+│  │
+│  ├─cover
+│  │      cover_image.png
+│  │
+│  └─images
+│          img1.png
+│          img2.png
+│          img3.png
+│          ...
+│
+└─sketch_210402a
+    │  sketch_210402a.pde
+    │  yacho.sketch.toml    <----------- Put sketch config file
+    │
+    ├─cover
+    │      cover_image.png
+    │
+    └─images
+            img1.png
+            img2.png
+            img3.png
+            ...
+```
+
+### Build site
+
+```
+yacho yacho.sketchbook.toml
+```
+
+Push `dist` to your gh-pages.
+
+### Example `yacho.sketchbook.toml`
+
+```toml
+sketchbook_root = '.'
+
+base_url = 'https://yacho-demo.netlify.app/'
+
+# Profile information
+author = 'eqs'
+avatar = 'chi.png' # relative path from sketchbook_root
+bio = """
+Creative Coder
+"""
+
+# Your custom css (relative path from sketchbook_root)
+custom_css = 'custom.css'
+
+[social]
+home = "https://www.eqseqs.work"
+twitter = "eqs_work"
+github = "eqs"
+instagram = ""
+youtube = ""
+facebook = ""
+```
+
+### Example `yacho.sketch.toml`
+
+```toml
+# If title is empty, sketch dir name will be used as title.
+title = "Flowers"
 
-## Authors
+# Default to false
+draft = false
 
-eqs ( `murashige.satoshi.mi1 [at] gmail.com` )
+comment = "An example comment."
+```