From 4d97257b748f1696c10a92da18fdc6d13ea91966 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?St=C3=A9phane=20Goetz?= Date: Fri, 27 Oct 2017 11:05:55 +0200 Subject: [PATCH] Remove mentions of Grunt in readme fixes #17 --- README.md | 14 ++++---------- 1 file changed, 4 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 7de8b92..6b6593a 100755 --- a/README.md +++ b/README.md @@ -169,18 +169,12 @@ Copy the files from the repo to a web server that can run PHP 5.4 or greater. ## Running Locally -There are several ways to run the docs locally. You can use something like MAMP or WAMP. If you are like me and use alot of Node.js and Grunt.js, then you can use the optional grunt command I have packaged with the project which will start a PHP web server for you in the project folder. +There are several ways to run the docs locally. +The recommended way is to run `daux serve` which will execute PHP's embedded server. -The Grunt.js task uses the built in web server in PHP 5.4 to host the docs on your local machine. This is really only intended be used when you are writing/updating a ton of docs and want to preview the changes locally. +By default the server will run at: http://localhost:8085 -**To use the optional Grunt command you will need:** - -* Node.js -* npm -* Grunt.js -* PHP 5.6 or greater - -This project contains a package.json file, so once you have the requirements installed, you can simply run a `npm install` and then `grunt` in the projects folder to start the local web server. By default the server will run at: http://localhost:8085 +This is really only intended be used when you are writing/updating a ton of docs and want to preview the changes locally. ## Generating a set of static files