From cc7aac0fda8d2ee6dad5215bd51ed8a8e7d1fa3f Mon Sep 17 00:00:00 2001 From: Joe Fletcher Date: Mon, 23 May 2016 10:55:13 -0700 Subject: [PATCH 1/2] Simplify Setup Instructions with example commands Clarifies set up by showing actual commands to use. copy and paste simple. --- README.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 4d040d7..2bd7487 100644 --- a/README.md +++ b/README.md @@ -6,13 +6,16 @@ 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 --- ### Help Grow This Feature List From 0e85c747543bd5af243e5ce1523cf3e3c82a9a6e Mon Sep 17 00:00:00 2001 From: Joe Fletcher Date: Mon, 23 May 2016 11:22:32 -0700 Subject: [PATCH 2/2] Simplify Update instructions, and clean up notes Simplified the update instructions, moved closer to the setup instructions since they are related, and clear up some of the other instructions. --- README.md | 25 +++++++++++++------------ 1 file changed, 13 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 2bd7487..9acd3a3 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,16 @@ git clone https://github.com/topdown/VVV-Dashboard.git dashboard cp dashboard/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 @@ -80,22 +90,13 @@ cp dashboard/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. ---