diff --git a/README b/README index e69de29..e3ac5cd 100644 --- a/README +++ b/README @@ -0,0 +1,15 @@ +How to use +========== + +Populate directory with markdown files (they have to end with .markdown). You +can also create arbitrarily nested subdirectories containing .markdown files. + +Sg will go recursively through all directories not beginning with an underscore +("_") and convert the .markdown files into .html. The resulting HTML files will +be saved into the _site directory, conserving the directory structure where the +.markdown file was found. + +Put your static content into _static. Files and subdirectories will be copied +into _site without any modifications. + +