mirror of
https://github.com/ulbwazhine/MockupEngineer.git
synced 2024-11-13 04:36:34 +03:00
readme.md
This commit is contained in:
parent
cce4f147ed
commit
b8b4b713c1
|
@ -49,7 +49,7 @@ $ python3 -m MockupEngineer
|
||||||
```
|
```
|
||||||
|
|
||||||
<div align="center">
|
<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>
|
</div>
|
||||||
|
|
||||||
#### In Python console:
|
#### In Python console:
|
||||||
|
@ -71,7 +71,7 @@ mockup.generate(template=mockup.templates[0],
|
||||||
#### `MockupEngineerInstance.generate` parameters:
|
#### `MockupEngineerInstance.generate` parameters:
|
||||||
* `template`: *Template* — Device template model, must be passed from *MockupEngineerInstance.templates* or *MockupEngineerInstance.get_templates()*.
|
* `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**.
|
* `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*.
|
* `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)
|
* `external_storage`: *Optional[bool]* — Optional parameter, true if you need to upload mockup on [TemporaryStorage](https://github.com/ulbwazhine/TemporaryStorage) (0x0.st etc)
|
||||||
|
|
||||||
|
|
|
@ -49,7 +49,7 @@ $ python3 -m MockupEngineer
|
||||||
```
|
```
|
||||||
|
|
||||||
<div align="center">
|
<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>
|
</div>
|
||||||
|
|
||||||
#### In Python console:
|
#### In Python console:
|
||||||
|
@ -71,7 +71,7 @@ mockup.generate(template=mockup.templates[0],
|
||||||
#### `MockupEngineerInstance.generate` parameters:
|
#### `MockupEngineerInstance.generate` parameters:
|
||||||
* `template`: *Template* — Device template model, must be passed from *MockupEngineerInstance.templates* or *MockupEngineerInstance.get_templates()*.
|
* `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**.
|
* `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*.
|
* `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)
|
* `external_storage`: *Optional[bool]* — Optional parameter, true if you need to upload mockup on [TemporaryStorage](https://github.com/ulbwazhine/TemporaryStorage) (0x0.st etc)
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue
Block a user