Skip to content

Commit

Permalink
Update README for cross-compilation
Browse files Browse the repository at this point in the history
  • Loading branch information
victorlin committed Jun 13, 2023
1 parent e227b7e commit 7ccea6e
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,9 +109,8 @@ To push images you've built locally to Docker Hub, you can run:

./devel/copy-images -t <tag>

This will copy the `nextstrain/base:<tag>` and `nextstrain/base-builder:<tag>`
images from the local Docker registry to Docker Hub. See instructions at the top
of the script for more options.
This will copy the Nextstrain images from the local Docker registry to Docker
Hub. See instructions at the top of the script for more options.

### Adding a new software program

Expand All @@ -136,12 +135,16 @@ To add a software program to `nextstrain/base`, follow steps in this order:
4. The last resort is to build from source. Look for instructions on the
software's website. Add a build command to the section labeled with `Build
programs from source`. Note that this can require platform-specific
instructions.
instructions. You should utilize cross-compilation tool available in the
builder stage that runs on the build platform.

If possible, pin the software to a specific version. Otherwise, add the
download/install/build command to the section labeled with `Add unpinned
programs` to ensure the latest version is included in every Docker image build.

If possible, add the program to the builder stage that runs on the build
platform to avoid slowness that may arise from emulation.

### Best practices

The smaller the image size, the better. To this end we build upon a ["slim"
Expand Down

0 comments on commit 7ccea6e

Please sign in to comment.