Skip to content

Commit

Permalink
* docs/GettingStarted.md
Browse files Browse the repository at this point in the history
  • Loading branch information
hiqsol committed Jul 10, 2015
1 parent dd5132a commit 48b75d3
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions docs/GettingStarted.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,24 @@
# Getting started

## Requirements
## Requirements

All you need is cli PHP and composer.

## Instalation

Hidev and plugins are installed with composer.

Globally:

~~~
composer global require hiqdev/hidev
~~~

Or locally at every project with require-dev in composer.json file, which is preffered cause this way you can have different set of plugins for that project.

It's better to have both. Globally installed hidev will look for locally installed hidev and run it instead when run from any project directory. So you can type just hidev (I prefer alias h in my shell) to run local vendor/bin/hidev.
Or locally at every project with require-dev in composer.json file.

## Hidev's directory
## config

Hidev keeps everything it needs: configs, intermediate files and so on in .hidev directory in the root of your project.
The main config file is: .hidev/config.yml.
Also .yaml extension can be used instead of .yml and JSON format works as well.
Hidev keeps everything it needs: configs, plugins, intermediate files and so on in .hidev directory in the root of your project.
The main config file is: .hidev/config.yml.
Also .yaml extension can be used instead of .yml and JSON format works as well.

0 comments on commit 48b75d3

Please sign in to comment.