-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
9 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. | ||
|