docs: Update dev docs w/ push info, and vm background info resources.

carlosperate · Jan 4, 2024 · d150dbc · d150dbc
1 parent 49c922b
commit d150dbc
Show file tree

Hide file tree

Showing 3 changed files with 37 additions and 15 deletions.
diff --git a/README.md b/README.md
@@ -60,15 +60,15 @@ docker run -it -p 5022:5022 ghcr.io/carlosperate/qemu-rpi-os-lite:bullseye-lates
 
 ## Available Images
 
-There are two main releases right now `buster-legacy-latest` and
+There are two main releases right now `buster-latest` and
 `bullseye-latest`:
 
 ```
 ghcr.io/carlosperate/qemu-rpi-os-lite:bullseye-latest
 ```
 
 ```
-ghcr.io/carlosperate/qemu-rpi-os-lite:buster-legacy-latest
+ghcr.io/carlosperate/qemu-rpi-os-lite:buster-latest
 ```
 
 Each Pi OS release has its own tag, including the OS release date in this
@@ -109,12 +109,6 @@ docker run -it ghcr.io/carlosperate/qemu-rpi-os-lite:jessie-latest
 docker run -it ghcr.io/carlosperate/qemu-rpi-os-lite:stretch-latest
 ```
 
-Tags for the older "buster" release, before it was renamed to "buster-legacy":
-
-```bash
-docker run -it ghcr.io/carlosperate/qemu-rpi-os-lite:buster-latest
-```
-
 ## Build and run this docker image from the repository
 
-This information can be found in the [dev_docs.md](dev_docs.md) file.
+This information can be found in the [dev-docs.md](dev-docs.md) file.
diff --git a/dev-docs.md b/dev-docs.md
@@ -22,7 +22,17 @@ docker run -it carlosperate/qemu-rpi-os-lite
 
 ### Publish docker image
 
-TBD.
+GitHub needs authentication with a personal token:
+
+```bash
+echo $CR_PAT | docker login ghcr.io -u <your_username> --password-stdin
+```
+```bash
+docker tag IMAGE_ID carlosperate/qemu-rpi-os-lite:VERSION
+```
+```bash
+docker push ghcr.io/carlosperate/qemu-rpi-os-lite:VERSION
+```
 
 
 ## `dockerpi` Fork
@@ -34,7 +44,10 @@ as listed in its [vm/README.md](vm/README.md) file.
 ### Build image
 
 ```bash
-docker build -t ghcr.io/carlosperate/dockerpi-vm:local .
+cd vm
+```
+```bash
+docker build -t ghcr.io/carlosperate/qemu-rpi-vm:local .
 ```
 
 ### Run container pointing to Pi OS image file
@@ -45,14 +58,16 @@ docker run -it --rm -v full_path_to.img:/sdcard/filesystem.img -p 5022:5022 ghcr
 
 ### Push image to GH Container Registry
 
+GitHub needs authentication with a personal token:
+
 ```bash
-docker login ghcr.io -u <your_username>
+echo $CR_PAT | docker login ghcr.io -u <your_username> --password-stdin
 ```
 ```bash
-docker tag IMAGE_ID ghcr.io/carlosperate/dockerpi-vm:VERSION
+docker tag IMAGE_ID ghcr.io/carlosperate/qemu-rpi-vm:VERSION
 ```
 ```bash
-docker push ghcr.io/carlosperate/dockerpi-vm:VERSION
+docker push ghcr.io/carlosperate/qemu-rpi-vm:VERSION
 ```
 
 ### `benchmark_vm.py` script

diff --git a/vm/README.md b/vm/README.md
@@ -42,9 +42,22 @@ List of changes:
     - Uses the `virt` machine type: https://www.qemu.org/docs/master/system/arm/virt.html
     - This is not an accurate Pi emulation, but has better performance and 1 GB of RAM
     - Docker image has to build the kernel, as the pi kernel does not include the required configuration
-    - commit [xxxxx](https://github.com/carlosperate/docker-qemu-rpi-os/commit/xxxx)
+    - commit [49c922b](https://github.com/carlosperate/docker-qemu-rpi-os/commit/49c922b8b9e30984767105cd8b9be960732ae095)
 - Added developer documentation for this fork to parent directory [../dev-docs.md](../dev-docs.md)
 
+Useful links:
+- [qemu-rpi-kernel](https://github.com/dhruvvyas90/qemu-rpi-kernel)
+- [Emulating a Raspberry Pi in QEMU](https://interrupt.memfault.com/blog/emulating-raspberry-pi-in-qemu)
+- [Emulating Raspberry Pi 4 with Qemu](https://gist.github.com/cGandom/23764ad5517c8ec1d7cd904b923ad863)
+- [Arm QEMU Debian 11 VM on x86/64 (amd64) Linux](https://www.willhaley.com/blog/debian-arm-qemu/)
+- [Raspberry Pi 4 emulation with QEMU virt](https://blog.grandtrunk.net/2023/03/raspberry-pi-4-emulation-with-qemu/)
+- [Raspberry Pi: How to cross-compile and use Mainline Kernel](https://gist.github.com/lategoodbye/c7317a42bf7f9c07f5a91baed8c68f75)
+- [Raspbian on QEMU with ARMv7](https://github.com/paulden/raspbian-on-qemu-armv7)
+- [QEMU for Beginner and Advanced](https://hackmd.io/@MarconiJiang/qemu_beginner)
+- [Installing Debian on QEMU’s 32-bit ARM “virt” board](https://translatedcode.wordpress.com/2016/11/03/installing-debian-on-qemus-32-bit-arm-virt-board/)
+- [Installing Debian on QEMU’s 64-bit ARM “virt” board](https://translatedcode.wordpress.com/2017/07/24/installing-debian-on-qemus-64-bit-arm-virt-board/)
+
+
 The rest of the original README can be seen below.
 
 ----------