Skip to content

Commit

Permalink
Merge pull request #31 from merchantguru/patch-1
Browse files Browse the repository at this point in the history
Simplify & Clarify Setup & Update Instructions
  • Loading branch information
topdown committed May 24, 2016
2 parents 43a1a65 + 0e85c74 commit 2d1146e
Showing 1 changed file with 20 additions and 16 deletions.
36 changes: 20 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,26 @@ It also suggests the wonderful add-on bash script [VVV Site Wizard](https://gith

[![Gitter Chat](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/topdown/VVV-Dashboard?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

Instructions
Setup
-
Clone this repo to your VVV/www/default/ directory:
Clone this repo to your VVV/www/default/ directory and then copy dashboard-custom.php there:

`git clone https://github.com/topdown/VVV-Dashboard.git dashboard`
```sh
cd www/default
git clone https://github.com/topdown/VVV-Dashboard.git dashboard
cp dashboard/dashboard-custom.php .
```

Copy the dashboard-custom.php to VVV/www/default/dashboard-custom.php
While VVV is running (`vagrant up`), the new dashboard is now viewable at your VVV root (usually [vvv](http://vvv) or [vvv.dev](http://vvv.dev)).

Update
-
Update your repo via `git pull` and then copy dashboard-custom.php to your default directory.
```sh
cd www/default/dashboard
git pull
cp dashboard-custom.php ..
```

---
### Help Grow This Feature List
Expand Down Expand Up @@ -77,22 +90,13 @@ Copy the dashboard-custom.php to VVV/www/default/dashboard-custom.php
* Migrations for databases. You can now migrate to a new domain.

---
### UPDATE Instructions
From your dashboard directory ```git pull```

### Note: Recent Changes
You no longer need to copy the style.css anywhere.

Delete the old VVV/www/default/dashboard-custom.php and copy the new version to VVV/www/default/dashboard-custom.php

Now move your dashboard directory so it is inside VVV/www/default/

As of 11/19/2015 there is a cache system, If don't see cache files on first dashboard load make sure dashboard/cache/ is writable. (It should be)

---

With Vagrant Up you should be able browse to your vagrant root www usually [vvv](http://vvv) or [vvv.dev](http://vvv.dev) and see the new dashboard.
There is now a cache system. If you don't see cache files on the first dashboard load, make sure dashboard/cache/ is writable (it should be).

** NEW: There are bound keys for the search feature, the enter key and down arrow key search down the list and the up arrow searches up.**
There are bound keys for the search feature: the enter key and down arrow key search down the list, and the up arrow searches up.

---

Expand Down

0 comments on commit 2d1146e

Please sign in to comment.