D3Public
/
daux.io
8
0
Vork 0
Code Pull-aanvragen Publicaties Activiteit

Remove mentions of Grunt in readme 

fixes #17
This commit is contained in:
Stéphane Goetz 2017-10-27 11:05:55 +02:00
bovenliggende fc3d88d0ae
commit 4d97257b74
1 gewijzigde bestanden met toevoegingen van 4 en 10 verwijderingen
Statistieken weergeven Download Patch-bestand Download Diff-bestand Expand all files Collapse all files

14
README.md
Bestand weergeven

@ -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 <a href="http://www.mamp.info/en/index.html" target="_blank">MAMP</a> or <a href="http://www.wampserver.com/en/" target="_blank">WAMP</a>. If you are like me and use alot of Node.js and <a href="http://gruntjs.com/" target="_blank">Grunt.js</a>, 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: <a href="http://localhost:8085" target="_blank">http://localhost:8085</a>
**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: <a href="http://localhost:8085" target="_blank">http://localhost:8085</a>
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