ulbwazhine/MockupEngineer
1
1
Fork 0
mirror of https://github.com/ulbwazhine/MockupEngineer.git synced 2024-11-21 16:36:34 +03:00
Code Issues Packages Projects Releases Wiki Activity

readme.md

Browse Source
This commit is contained in:
ульба 2022-02-02 19:16:40 +05:00
parent cce4f147ed
commit b8b4b713c1
2 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
readme-template.md
View File

@ -49,7 +49,7 @@ $ python3 -m MockupEngineer
```
<div align="center">
<img width="70%" src="https://raw.githubusercontent.com/ulbwazhine/MockupEngineer/main/MockupEngineer/templates/console_example.jpeg" alt="">
<img width="70%" src="https://raw.githubusercontent.com/ulbwazhine/MockupEngineer/main/MockupEngineer/templates/console_example.png" alt="Usage as a standalone application">
</div>
#### In Python console:
@ -71,7 +71,7 @@ mockup.generate(template=mockup.templates[0],
#### `MockupEngineerInstance.generate` parameters:
* `template`: *Template* — Device template model, must be passed from *MockupEngineerInstance.templates* or *MockupEngineerInstance.get_templates()*.
* `screenshot_path`: *str* — Absolute path to the image in **JPG, PNG format**.
* `color`: *Optional[str]* — Optional parameter, force device color. Must be passed according to *Template.colors[**n**].color*
* `color`: *Optional[str]* — Optional parameter, force device color. Must be passed according to *Template.colors[**n**].color*.
* `orientation`: *str* — Optional parameter, force device orientation. Must be *landscape* or *portrait*.
* `external_storage`: *Optional[bool]* — Optional parameter, true if you need to upload mockup on [TemporaryStorage](https://github.com/ulbwazhine/TemporaryStorage) (0x0.st etc)

4
readme.md
View File

@ -49,7 +49,7 @@ $ python3 -m MockupEngineer
```
<div align="center">
<img width="70%" src="https://raw.githubusercontent.com/ulbwazhine/MockupEngineer/main/MockupEngineer/templates/console_example.jpeg" alt="">
<img width="70%" src="https://raw.githubusercontent.com/ulbwazhine/MockupEngineer/main/MockupEngineer/templates/console_example.png" alt="Usage as a standalone application">
</div>
#### In Python console:
@ -71,7 +71,7 @@ mockup.generate(template=mockup.templates[0],
#### `MockupEngineerInstance.generate` parameters:
* `template`: *Template* — Device template model, must be passed from *MockupEngineerInstance.templates* or *MockupEngineerInstance.get_templates()*.
* `screenshot_path`: *str* — Absolute path to the image in **JPG, PNG format**.
* `color`: *Optional[str]* — Optional parameter, force device color. Must be passed according to *Template.colors[**n**].color*
* `color`: *Optional[str]* — Optional parameter, force device color. Must be passed according to *Template.colors[**n**].color*.
* `orientation`: *str* — Optional parameter, force device orientation. Must be *landscape* or *portrait*.
* `external_storage`: *Optional[bool]* — Optional parameter, true if you need to upload mockup on [TemporaryStorage](https://github.com/ulbwazhine/TemporaryStorage) (0x0.st etc)