Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

sc-70154-update-qml-readme-to-highlight-image-standards #1184

Merged
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,8 +66,23 @@ quantum computing paper/result.

where `<demo name>` is a sub-directory with the name of
your demo.
<details>
<summary><b>Follow these standards when adding images</b></summary>

### File Size
* Always aim to keep the image file size in kilobytes (KB’s)
* Always compress the image to the best possible size where quality is acceptable.

### Formats
* Use `.png` for everything (decorative images, descriptive images, logos etc)
* Use `.gif` for animated images

### Dimensions
* To maintain quality and performance, every image should be twice (2X) its visible dimension size on the web page, and at a minimum of `150 ppi/dpi` (preferably `300 ppi/dpi`).
</details><br>

- Add and select an author photo from the `_static/authors` folder. The image name should be as `<author name>_<author surname>.<format>`. If this is a new author and their image is not a headshot, store the original image as `<author name>_<author surname>_original.<format>` and create a cropped headshot with the aforementioned name.

- In the same folder create a `<author name>.txt` file where to include the bio following this structure:

```txt
Expand Down
Loading