Skip to content

Commit 2bd4f53

Browse files
authored
Docker and image compression info tweaks (#1115)
Two minor maintenance copy tweaks: - Newer version of Docker use "docker compose up" instead of "docker-compose up". This updates the info about local development in the README - The local build does no longer automatically compress images, so I removed that part and added a note about using a compression tool like ImageOpti.
1 parent d962702 commit 2bd4f53

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -80,4 +80,4 @@ You can also run site locally with Docker.
8080

8181
1. [Install docker](https://www.docker.com/products/docker-desktop)
8282
2. `cd` into a directory, for example `cd Documents/Guide`
83-
3. Run `docker-compose up` (you may need to wait for 5-10 minutes)
83+
3. Run `docker compose up` (you may need to wait for 5-10 minutes, use `docker-compose up` for older versions of Docker)

guide/contribute/illustration-guidelines.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,7 @@ Create and specify differently laid out images for desktop and mobile as needed.
154154

155155
## File size optimization
156156

157-
Optimize your images before committing them. The easiest way is to [build and run this repository locally](https://github.com/BitcoinDesign/Guide#how-to-build-and-run-the-site-locally). Images will be automatically compressed as you add them. After compression, ensure that the quality is still acceptable. Heavily textured images are sometimes heavily compressed, resulting in visible compression crystals, blurry lines and other visual artefacts.
157+
Use PNG for images with mostly flat colors and JPG for more photographic images. Optimize your images before committing them. The easiest way is by using a tool like [ImageOptim]http://imageoptim.com). After compression, ensure that the quality is still acceptable. Heavily textured images are sometimes heavily compressed, resulting in visible compression crystals, blurry lines and other visual artefacts.
158158

159159
## Link preview images
160160

0 commit comments

Comments
 (0)