Skip to content

Commit

Permalink
Readme Improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
mayamcdougall committed Feb 25, 2022
1 parent e505161 commit af1fc97
Showing 1 changed file with 8 additions and 19 deletions.
27 changes: 8 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.

## <a href="https://html5up.net/uploads/demos/dimension/">Demo</a>

Expand Down

0 comments on commit af1fc97

Please sign in to comment.