You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+11-10Lines changed: 11 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,14 +6,14 @@ Assemble screenshots of web projects for your portfolio
6
6
7
7
Once a web project is done, it's time to document your hard work and show it off. _Portfoliofy_ makes that process easier by doing all the screenshots for you and assembling them together into portfolio-ready files.
8
8
9
-
As of v2.0.0, the following files can be generated:
9
+
As of v2.1.0, the following `OUTPUT_` types can be generated:
10
10
11
-
*`SCREENSHOTS`
12
-
* Four image files of screenshots taken in different viewports (desktop - 2160x1360, laptop - 1440x900, tablet - 768x1024, smartphone - 230x490).
13
-
*`MAIN`
11
+
*`OUTPUT_SCREENSHOTS`
12
+
* Four image files of screenshots taken in different window sizes mimicking the viewport of a desktop (2160x1360), a laptop (1440x900), a tablet (768x1024) and a smartphone (230x490).
13
+
*`OUTPUT_MAIN`
14
14
* An image file of those screenshots overlaid on top schematic diagrams and then collaged together. (See below for an example ouput.)
15
-
*`BROWSER`
16
-
*A image file of the desktop screenshot overlaid on top of a schematic diagram. (Scroll to the bottom for an example ouput.)
15
+
*`OUTPUT_BROWSER`
16
+
*An image file of the desktop screenshot overlaid on top of a schematic diagram. (Scroll to the bottom for an example ouput.)
Open `local_settings.py` and change the value of `url` to the one you want to portfoliofy.
45
+
At minimum change the `url`[parameter](https://github.com/ggeerraarrdd/portfoliofy#parameters) in `local_settings.py` to the webpage you want to portfoliofy.
46
46
47
47
Then run the following command:
48
48
@@ -62,7 +62,7 @@ This is a list of parameters you can change in `local_settings.py`.
62
62
| wait | int | 2 | 0-60 | Time in seconds to allow URL to load before taking screenshot. |
63
63
| screenshots | bool | True | True, False | If TRUE, all screenshots are saved. |
64
64
65
-
The `MAIN` and `BROWSER` output files are generated by default but you can change this default behavior by editing the value of `request`. You can also customize the output files.
65
+
`OUTPUT_MAIN` and `OUTPUT_BROWSER`are generated by default but you can change this default behavior by editing the value of `request` in their respective dict in `user_input`. Other customizations can be set.
66
66
67
67
| Parameter | Type | Default value | Value range | Description |
@@ -76,7 +76,7 @@ The `MAIN` and `BROWSER` output files are generated by default but you can chang
76
76
77
77
### Example
78
78
79
-
This code will portfoliofy a web page served on a web server running on a local machine. It only requests the `BROWSER` output file in the default PNG format. The `MAIN` output file will not be processed. But all screenshots will be saved. All other parameters are also set to their default values.
79
+
This code will portfoliofy a webpage served on a web server running on a local computer. It only requests `OUTPUT_BROWSER`in the default PNG format. `OUTPUT_MAIN`will not be processed. But all `OUTPUT_SCREENSHOTS` will be saved. All other parameters remain set to their default values.
80
80
81
81
```python
82
82
user_input = {
@@ -123,7 +123,8 @@ The [initial realease](https://github.com/ggeerraarrdd/portfoliofy/releases/tag/
0 commit comments