Update readme
This commit is contained in:
parent
01bf72155c
commit
3c5a87eac8
1 changed files with 21 additions and 4 deletions
25
README.md
25
README.md
|
@ -2,6 +2,11 @@
|
||||||
|
|
||||||
This script allows a create new project using a ready-made templates.
|
This script allows a create new project using a ready-made templates.
|
||||||
|
|
||||||
|
You can use template on local machine or repositories.
|
||||||
|
|
||||||
|
By default it looks for a name of template in the
|
||||||
|
[official repository](https://github.com/ictmpl)
|
||||||
|
|
||||||
|
|
||||||
# Installing
|
# Installing
|
||||||
|
|
||||||
|
@ -14,11 +19,23 @@ or globally:
|
||||||
|
|
||||||
# Usage
|
# Usage
|
||||||
|
|
||||||
ictmpl create <project_path> <template_name>
|
## create
|
||||||
|
|
||||||
|
Create new project by template
|
||||||
|
|
||||||
|
`ictmpl create <project_path> <template_name>`
|
||||||
|
|
||||||
|
#### Params:
|
||||||
|
|
||||||
|
**project_path** - Path to new project directory
|
||||||
|
|
||||||
|
**template_name** - Name of template / link to git repository / local path
|
||||||
|
|
||||||
ictmpl create flaskproject flask-blank
|
#### Examples:
|
||||||
|
|
||||||
|
`ictmpl create flaskproject flask-blank`
|
||||||
|
|
||||||
ictmpl create myproject ../my-local-template/
|
`ictmpl create myproject ../my-local-template/`
|
||||||
|
|
||||||
ictmpl create /var/www/myproject https://github.com/ictmpl/flask-blank.git
|
`ictmpl create /var/www/myproject https://github.com/ictmpl/flask-blank.git`
|
||||||
|
|
||||||
|
|
Reference in a new issue