brysonsteck/devkitPro
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

update readme

Browse source
This commit is contained in:
Bryson Steck 2025-03-02 20:02:16 -07:00
parent 90406677b8
commit 627ba50ef3
Signed by: brysonsteck
SSH key fingerprint: SHA256:XpKABw/nP4z8UVaH+weLaBnEOD86+cVwif+QjuYLGT4
1 changed files with 31 additions and 23 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

54
README.md
View file

@ -1,35 +1,43 @@
# devkitPro Docker Development Containers
devkitPro is a collection of different toolchains created for developing homebrew for home consoles, most notably for Nintendo consoles. They are fairly robust, however the only supported method is to use their Pacman (Arch Linux) repositories, requiring the installation of Pacman for other Linux distributions and operating systems.
[devkitPro](https://devkitpro.org/) is a collection of different toolchains created for developing homebrew for home consoles, most notably for Nintendo consoles in the sixth-generation and later. They are fairly robust at this task, however the only supported method is to use their Pacman (Arch Linux) repositories, requiring the installation of Pacman on other Linux distributions and operating systems. devkitPro has installers for Linux, Windows, and macOS, but they all are managed by Pacman underneath.
This repo hopes to create a development environment that is usable for developing homebrew on other systems without needing to install Pacman to their system. I feel that needing to install a package manager other than the one your system ships with makes things more complicated and can confuse your current package manager, so having an isolated environment will solve that problem and allow people to use fairly vanilla systems.
This repo hopes to create a development environment that is usable for developing homebrew on other systems without needing to install a secondary package manager. I feel that needing to install a package manager other than the one your system ships with makes things more complicated and can confuse your primary package manager if changes are taken lightly, so having an isolated environment will solve that problem and allow people to use fairly vanilla systems.
This should also please Windows users who wish to develop homebrew, as they don't need to install MSYS for just this purpose.
**THIS REPO IS NOT OFFICIALLY SUPPORTED BY DEVKITPRO AND SHOULD NOT BE CONSIDERED AN OFFICIAL OUTLET TO USE THE TOOLCHAINS PROVIDED BY DEVKITPRO.**
## 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.
1. Windows and macOS users may want to install [Docker Desktop](https://www.docker.com/products/docker-desktop/) instead.
1. Install [Docker](https://docs.docker.com/engine/install/), [Git](https://git-scm.com/), and [OpenSSH](https://www.openssh.com/) using your package manager or by downloading them manually. SSH is usually preinstalled on Windows, macOS, and most Linux distros. 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. If you do not have an SSH public/private key pair, you can generate it with the following command. Keep note of where you saved your key pair.
```sh
ssh-keygen
```
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" --build-arg UID=$(id -u) --build-arg GID=$(id -g) --secret id=key,src=/path/to/your/keypair/id_rsa.pub .
```
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
```
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 container create --name devkitpro-container -v /path/to/your/project:/volume -p 2222:2222 devkitpro
docker container start devkitpro-container
```
1. You can now access this container via SSH using your favorite development tools, such as VSCode or simply in a terminal.
```sh
ssh -p 2222 devkitpro@localhost
```
1. This image is based off of `archlinux`, so you also have the ability to run a shell directly if you wish.
```sh
$ docker exec -it devkitpro-container bash
[devkitpro@0123456789ab volume]$
```
1. To stop the container, run this command on the host:
```sh
docker container stop devkitpro-container
```
```sh
docker container stop devkitpro-container
```