Skip to content

Readme dev image updates - #218

Merged
smclacke merged 3 commits into
mainfrom
readme-dev-image-updates
May 6, 2026
Merged

Readme dev image updates#218
smclacke merged 3 commits into
mainfrom
readme-dev-image-updates

Conversation

@smclacke

Copy link
Copy Markdown
Contributor

README.md

  • reordered to put github pages workflow first, clarifying this to be the primary workflow
  • noted that dockerfiles/debian_large image is too large for github pages
  • noted that sudo is not installed, users have root by default

Dockerfiles

  • updated the base image fixing github pages issues, also tested this locally

Other

  • added 'custom-disk-images' directory with .gitkeep since this is part of the tutorial for local hosting but directory wasn't in the repo

Still need to:

  • merge Alphine repo into this one
  • bundle tips into connection tips section

…s dir exists + is persistent. updated dockerfiles with a clear base image fixing GH pages issues. re-worked the dev section of the readme, including additions comments from merlin
@smclacke
smclacke requested a review from codingfrog27 April 29, 2026 13:33

@codingfrog27 codingfrog27 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good! Made a small wording suggestion and noted a todo for the future.

Comment thread README.md
<img src="/assets/fork_deploy_instructions.gif" alt="deploy_instructions_gif" width="90%">

1. **Fork the repository**
2. **Enable GitHub Pages** _via forked repository_ in Settings → Pages using "GitHub Actions" as source

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
2. **Enable GitHub Pages** _via forked repository_ in Settings → Pages using "GitHub Actions" as source
2. **Enable GitHub Pages** in your forked repository settings → Pages using "GitHub Actions" as source

Comment thread README.md

<img src="/assets/result.png" width="70%">

The same `Deploy` workflow also builds custom `.ext2` disk images from a Dockerfile. You can point it at `dockerfiles/debian_mini` or another Dockerfile, then either publish the result as a GitHub Release asset or deploy the Pages build from your fork.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

future todo: reword this section

@smclacke
smclacke merged commit 95eead4 into main May 6, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants