Skip to content
This repository has been archived by the owner on Dec 7, 2023. It is now read-only.

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
bycEEE committed Oct 23, 2018
1 parent 6751c50 commit 5a6805c
Showing 1 changed file with 46 additions and 3 deletions.
49 changes: 46 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,46 @@
# Tinfoil USB Installer
Rewrite of the python Tinfoil USB installer script in golang:
[https://github.com/XorTroll/Tinfoil/blob/master/tools/usb_install_pc.py](https://github.com/XorTroll/Tinfoil/blob/master/tools/usb_install_pc.py)
# TinfoilUSBGo
TinfoilUSBGo is a Golang rewrite of the Python Tinfoil USB installer script:
[https://github.com/XorTroll/Tinfoil/blob/master/tools/usb_install_pc.py](https://github.com/XorTroll/Tinfoil/blob/master/tools/usb_install_pc.py).

Tinfoil is a Nintendo Switch homebrew application used to manage titles. The
existing Python 3 script was written to interface with Tinfoil's USB
installation. This rewrite intends to eliminate the Python 3 dependency for
those who do not wish to install it (mainly for Windows users).

# Setup
### Windows
To interface with the Nintendo Switch, the libusbK driver is required.

1. Download Zadig: [https://zadig.akeo.ie/](https://zadig.akeo.ie/).
2. With your Nintendo Switch plugged in and on the Tinfoil USB install menu, choose
"List All Devices" under the options menu in Zadig, and select libnx USB comms.
3. Choose libusbK from the driver list and click the "Replace Driver" button.

### macOS
Under construction.

### Linux
Under construction.

# Usage
### Windows
1. Plug in your Nintendo Switch and navigate to Tinfoil's USB install page.
2. Open `cmd` or `PowerShell` and navigate to the downloaded `exe`.
3. Run the application using `.\tinfoilusbgo-windows-10.0-amd64.exe [nsp_path]`.

# Build
TinfoilUSBGo uses [xgo](https://github.com/karalabe/xgo) to cross-compile to
Windows and Linux. Xgo requires `docker` installed to build and run.

### Windows
```sh
make build-windows
```

### macOS
```sh
make build-osx
```

### Linux
Under construction.

0 comments on commit 5a6805c

Please sign in to comment.