From af1fc97b15fa3157c2499dd633ed9b089a825984 Mon Sep 17 00:00:00 2001 From: Maya McDougall <12779160+mayamcdougall@users.noreply.github.com> Date: Fri, 25 Feb 2022 15:05:58 -0500 Subject: [PATCH] Readme Improvements --- README.md | 27 ++++++++------------------- 1 file changed, 8 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index ac8f041..a99f7b6 100644 --- a/README.md +++ b/README.md @@ -1,29 +1,18 @@ # Dimension -HTML5UP Dimension Template For Pico CMS -This is Dimension, a fun little one-pager with modal-ized (is that a word?) "pages" and a cool depth effect (click on a menu item to see what I mean). Simple, fully responsive, and kitted out with all the usual pre-styled elements you'd expect. Hope you dig it :) +[HTML5 UP Dimension](https://html5up.net/dimension) Template For Pico CMS -## Installation - -Download the dimension folder and extract it to the themes folder of your Pico installation. - -Update Pico CMS configuration to use dimension theme: +This is Dimension, a fun little one-pager with modal "pages" and a cool depth effect (click on a menu item to see what I mean). Simple, fully responsive, and kitted out with all the usual pre-styled elements you'd expect. Hope you dig it. :) -* Pico CMS < 2.0 - - Change the following setting within your config.php: - - `$config['theme'] = 'dimension';` - -* Pico CMS >= 2.0 - - Add to config/config.yml +## Installation - `theme: dimension` +1) Download the `dimension` folder and extract it to the `themes` folder of your Pico installation. - (If the file does not exist, create it. For more info see config/config.yml.template) +2) Set your theme to `dimension` in Pico's config file: + - **For Pico 2.0+**: Set `theme: dimension` in `config.yml`. + - **For older versions of Pico**: Set `$config['theme'] = 'dimension';` in `config.php`. -For the front page download our `index.md`, upload it in the content folder and make your changes. +3) Configure your front page using `index.md`. You can download our `content-sample/index.md`, to use as a template, or just create your own. See [`content-sample/index.md`](https://github.com/BesrourMS/dimension/blob/master/content-sample/index.md?plain=1) for more information. ## Demo