From 32ad6b2b720a73cafc7f67c2fd67679104bd9aaa Mon Sep 17 00:00:00 2001 From: Bryson Steck Date: Sat, 15 Feb 2025 16:57:29 -0700 Subject: [PATCH] fix formatting --- README.md | 36 ++++++++++++++++++------------------ 1 file changed, 18 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 6c21795..671efe2 100644 --- a/README.md +++ b/README.md @@ -9,27 +9,27 @@ This repo hopes to create a development environment that is usable for developin ## How to use 1. Install [Docker](https://docs.docker.com/engine/install/) and [Git](https://git-scm.com/) using your package manager or by downloading them manually. - - Windows and macOS users may want to install [Docker Desktop](https://www.docker.com/products/docker-desktop/) instead. + 1. Windows and macOS users may want to install [Docker Desktop](https://www.docker.com/products/docker-desktop/) instead. 1. Clone this repository and enter it. -```sh -git clone https://git.brysonsteck.xyz/brysonsteck/devkitPro.git && cd devkitPro -``` + ```sh + git clone https://git.brysonsteck.xyz/brysonsteck/devkitPro.git && cd devkitPro + ``` 1. Run this command to build a Docker image for the tools you need. For a list of package names, see the section "Unix-like platforms" on the [devkitPro Wiki](https://devkitpro.org/wiki/Getting_Started#Unix-like_platforms). -```sh -docker build -t devkitpro --build-arg TOOLS="wii-dev" . -``` + ```sh + docker build -t devkitpro --build-arg TOOLS="wii-dev" . + ``` 1. Create and start a container from this new image. The work directory is set to `/volume`, so it's recommended to mount your project's directory to that location. -```sh -docker container create --name devkitpro-container -v /path/to/project:/volume devkitPro -docker container start devkitpro-container -``` + ```sh + docker container create --name devkitpro-container -v /path/to/project:/volume devkitPro + docker container start devkitpro-container + ``` 1. You can now access this container using `docker exec`. This image is based off of `archlinux`, so you have the ability to run a shell. -```sh -$ docker exec -it devkitpro-container bash -[devkitpro@d41c71ef5898 volume]$ -``` + ```sh + $ docker exec -it devkitpro-container bash + [devkitpro@d41c71ef5898 volume]$ + ``` 1. To stop the container, run this command on the host: -```sh -docker container stop devkitpro-container -``` + ```sh + docker container stop devkitpro-container + ```