Skip to content

Commit

Permalink
vm: Remove unnecessary upstream files, update docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
carlosperate committed Dec 29, 2023
1 parent 9837075 commit b8550bf
Show file tree
Hide file tree
Showing 11 changed files with 61 additions and 663 deletions.
16 changes: 1 addition & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,18 +117,4 @@ docker run -it ghcr.io/carlosperate/qemu-rpi-os-lite:buster-latest

## Build and run this docker image from the repository

```
git clone https://github.com/carlosperate/docker-qemu-rpi-os.git
```

```
cd docker-qemu-rpi-os
```

```
docker build -t carlosperate/qemu-rpi-os-lite .
```

```
docker run -it carlosperate/qemu-rpi-os-lite
```
This information can be found in the [dev_docs.md](dev_docs.md) file.
56 changes: 56 additions & 0 deletions dev-docs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
# Development Documentation

## `qemu-rpi-os-lite`

### Build docker image

```bash
git clone https://github.com/carlosperate/docker-qemu-rpi-os.git
```
```bash
cd docker-qemu-rpi-os
```
```bash
docker build -t carlosperate/qemu-rpi-os-lite .
```

### Run docker image

```bash
docker run -it carlosperate/qemu-rpi-os-lite
```

### Publish docker image

TBD.


## `dockerpi` Fork

The [vm](vm) folder contains a fork of the
[dockerpi](https://github.com/lukechilds/dockerpi/) project, with modifications
as listed in its [vm/README.md](vm/README.md) file.

### Build image

```bash
docker build -t ghcr.io/carlosperate/dockerpi-vm:local .
```

### Run container pointing to Pi OS image file

```bash
docker run -it --rm -v full_path_to.img:/sdcard/filesystem.img -p 5022:5022 ghcr.io/carlosperate/dockerpi-vm:local
```

### Push image to GH Container Registry

```bash
docker login ghcr.io -u <your_username>
```
```bash
docker tag IMAGE_ID ghcr.io/carlosperate/dockerpi-vm:VERSION
```
```bash
docker push ghcr.io/carlosperate/dockerpi-vm:VERSION
```
7 changes: 0 additions & 7 deletions vm/.github/FUNDING.yml

This file was deleted.

50 changes: 0 additions & 50 deletions vm/.github/workflows/ci.yml

This file was deleted.

1 change: 0 additions & 1 deletion vm/.gitignore

This file was deleted.

1 change: 1 addition & 0 deletions vm/LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
MIT License

Copyright (c) 2017 Luke Childs
Copyright (c) 2023 Carlos Pereira Atencio and contributors

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
6 changes: 3 additions & 3 deletions vm/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<div align="center">
<img width="256" src="media/logo.svg">
<img width="256" src="https://raw.githubusercontent.com/lukechilds/dockerpi/5f58e8b5fefde0e5d4aedd19d7c04a2ff77eb4c3/media/logo.svg">
</div>

# dockerpi Fork
Expand Down Expand Up @@ -35,7 +35,7 @@ List of changes:
https://bugs.launchpad.net/ubuntu/+source/libslirp/+bug/2029431
https://www.mail-archive.com/qemu-devel@nongnu.org/msg903610.html
- `entrypoint.sh`: Output of `qemu-img info` now returns multiple `virtual-size` keys and only one needed
- Added developer documentation for this fork to [dev-docs.md](dev-docs.md)
- Added developer documentation for this fork to [../dev-docs.md](../dev-docs.md)

The rest of the original README can be seen below.

Expand All @@ -48,7 +48,7 @@ Gives you access to a virtualised ARM based Raspberry Pi machine running the Ras
This is not just a Raspian Docker image, it's a full ARM based Raspberry Pi virtual machine environment.

<div align="center">
<img src="media/demo.svg" width="720">
<img src="https://raw.githubusercontent.com/lukechilds/dockerpi/5f58e8b5fefde0e5d4aedd19d7c04a2ff77eb4c3/media/demo.svg" width="720">
</div>

## Usage
Expand Down
25 changes: 0 additions & 25 deletions vm/dev-docs.md

This file was deleted.

Loading

0 comments on commit b8550bf

Please sign in to comment.