This repository has been archived by the owner on May 8, 2018. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch '136-release-2-0-0' into 'develop'
Resolve "Release 2.0.0" Closes #136 See merge request development-tools/boilerplate-generator!40
- Loading branch information
Showing
10 changed files
with
134 additions
and
49 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
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
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
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
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
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
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
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 |
---|---|---|
@@ -0,0 +1,59 @@ | ||
# Running the Pixel2HTML Generator | ||
|
||
### Option 1: Answering the questions | ||
|
||
To generate the **Pixel2HTML Boilerplate** go to your project folder and run this command in your shell | ||
|
||
``` | ||
$ cd ~/your/project/folder | ||
$ yo pixel2html | ||
``` | ||
The **Pixel2HTML Boilerplate** will ask you questions about this points. Answering with the desired options will generate the code. | ||
|
||
* Project Name? | ||
* Quantity of screens? | ||
* Markup Language? _Options: HTML/Pug_ | ||
* Markup Integration? _Options: None/Jekyll_ | ||
* Frontend Framework _Options: None/Bootstrap/Foundation_ | ||
* jQuery? _Options: true/false_ | ||
|
||
|
||
### Option 2: Using available parameters | ||
|
||
You also can answer this questions passing parameters to the generator command. | ||
|
||
Here there are the available questions: | ||
|
||
* ```--projectName``` (*string*) | ||
* ```--qtyScreens``` (*int*) | ||
* ```--markupLanguage``` (*string*) [html, pug] | ||
* ```--markupIntegration``` (*string*) [jekyll, none] | ||
* ```--frontEndFramework``` (*string*) [bootstrap, foundation, none] | ||
* ```--jQuery``` (*bool*) | ||
|
||
Example: | ||
|
||
``` | ||
$ yo pixel2html --projectName=Floyd --markupLanguage='html' | ||
``` | ||
|
||
### Option 3: Using the config file | ||
|
||
You can create a `.project.conf` file in the root directory of your project. | ||
Here an example of it's structure: | ||
|
||
``` | ||
{ | ||
"projectName": 'XXX', | ||
"qtyScreens": 4, | ||
"markupLanguage": 'html', | ||
"markupIntegration": 'jekyll', | ||
"frontEndFramework": "bootstrap", | ||
"jQuery": true | ||
} | ||
``` | ||
|
||
Once you answered all the question, you can hit at: | ||
``` | ||
$ yo pixel2html | ||
``` |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
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