Browse files

Add screenshots and installation instructions

  • Loading branch information...
1 parent bf2944a commit 33ab43628ba38ec756669da8bed2054aab0a22d0 @rwdaigle committed Feb 20, 2012
Showing with 40 additions and 8 deletions.
  1. +40 −8
@@ -2,10 +2,24 @@
The Clean theme was developed for Nesta CMS with a focus on:
-* Readability: the content should get main billing
+* Readability: the content should be the sole focus of the site and should be as easily consumed as possible
* Syntax highlighting: developed by a developer for developers it should always have first-class support for syntax highlighting
* Cloudability: the theme should always play well with cloud environments like Heroku
+## Screenshots
+### Home page/articles list
+![Home/article list screenshot](
+### Article w/ TOC
+![Article screenshot](
+### Syntax highlighting
+![Syntax highlighting screenshot](
## Environment dependencies
The following environment varibles are used by Clean.
@@ -16,11 +30,29 @@ The following environment varibles are used by Clean.
* `NESTA_AUTHOR__LINKEDIN`: The author's public LinkedIn URL shortname. Example: `rwdaigle` will result in `` being used.
* `NESTA_POWERED_BY`: If you want to have the small Heroku logo displayed in the footer, set this to 'true'. Delete it if you don't.
-Several standard Nesta variables are also referenced.
+Several standard Nesta variables are also referenced and should be set for the best experience.
+## Installation
+Install the theme as a git submodule to get the benefits of future updates.
+mysite$ git submodule add git:// themes/clean
+And make sure your `config/config.yml` file (or `NESTA_THEME` env var) specifies the `clean` theme.
+The Nesta-approved installation method is to do:
+mysite$ nesta theme:install git://
+though future updates won't be as easily propogated.

0 comments on commit 33ab436

Please sign in to comment.