feat: Updates README to reflect updates for base image of a dev container.
All checks were successful
Create and publish a Docker image / build-and-push-image (push) Successful in 5m40s

This commit is contained in:
2026-02-01 16:24:14 -05:00
parent 125209a99b
commit 27337cd0e0
3 changed files with 76 additions and 48 deletions

View File

@@ -1,34 +1,46 @@
# Swift development container
A development container built off swift / ubuntu as base image. This is needed because I currently can not get swift to
install on arch linux, so this is used to develop inside a docker container.
A development container built off swift / ubuntu as base image. This is typically
used as a base image for a `devcontainer` for for a swift project.
## Extra Packages
## Installed Packages
This image includes my relevant dotfiles (shell, neovim, scripts, etc.) and the
following extra packages:
- bob (neovim version manager)
- cmake
- curl
- git
- direnv
- eza
- fzf
- neovim (nightly)
- tree-sitter-cli
- wget
- ripgrep
- starship
- zsh
## Usage
```bash
podman run -it --name "$(basename "$PWD")" \
-v "$HOME/.config/nvim":/root/.config/nvim \
-v "$HOME/.local/share/nvim":/root/.local/share/nvim \
-v "$PWD":/root/dev \
-w /root/dev \
git.housh.dev/michael/swift-dev-container:latest
In a new project, use this image as the base image for your dev container.
**.devcontainer/devcontainer.json**
```json
{
"name": "Swift",
"image": "git.housh.dev/swift-dev:latest",
"features": {
...
},
...
"remoteUser": "swift"
}
```
### Notes
### Start the dev container.
The default command will open neovim in the `/root/dev` folder.
```bash
devpod up . --ide=none
```
The above runs a container and names it so that it can be restarted in the future to continue working on a project.
The `-w | --workdir` is not required if you mount your project to the `/root/dev` folder, as that is the default
declared by the container, it is shown here for clarity.