From b5ccc835258d1a8e8c38ad489c4abe9e485934cb Mon Sep 17 00:00:00 2001 From: Koutaro Mukai Date: Tue, 15 Oct 2024 00:11:20 +0900 Subject: [PATCH] Update documents --- Makefile | 48 ---------------------------- README.md | 22 ++++++++----- lib/jiangtun-core/library.properties | 2 +- 3 files changed, 15 insertions(+), 57 deletions(-) delete mode 100644 Makefile diff --git a/Makefile b/Makefile deleted file mode 100644 index 37c2ee2..0000000 --- a/Makefile +++ /dev/null @@ -1,48 +0,0 @@ -.PHONY: all clean - -ifeq ($(OS),Windows_NT) - RM = powershell -Command Remove-Item -Recurse -Force - CP = copy - FIXPATH = $(subst /,\,$1) - PIO = $(USERPROFILE)\.platformio\penv\Scripts\platformio.exe -else - RM = rm -rf - CP = cp - FIXPATH = $1 - PIO = $(HOME)/.platformio/penv/bin/platformio -endif - -VERSION = v2.0.0-alpha - -.pio/build/pico/firmware.uf2: src/main.cpp src/jiangtun.h - $(PIO) run --environment pico - -.pio/build/dol-pico/firmware.uf2: src/main.cpp src/jiangtun.h - $(PIO) run --environment dol-pico - -.pio/build/xiao-rp2040/firmware.uf2: src/main.cpp src/jiangtun.h - $(PIO) run --environment xiao-rp2040 - -.pio/build/dol-xiao-rp2040/firmware.uf2: src/main.cpp src/jiangtun.h - $(PIO) run --environment dol-xiao-rp2040 - -dist: - mkdir dist - -dist/jiangtun-$(VERSION)-pico.uf2: .pio/build/pico/firmware.uf2 dist - $(CP) $(call FIXPATH,$<) $(call FIXPATH,$@) - -dist/jiangtun-$(VERSION)-dol-pico.uf2: .pio/build/dol-pico/firmware.uf2 dist - $(CP) $(call FIXPATH,$<) $(call FIXPATH,$@) - -dist/jiangtun-$(VERSION)-xiao-rp2040.uf2: .pio/build/xiao-rp2040/firmware.uf2 dist - $(CP) $(call FIXPATH,$<) $(call FIXPATH,$@) - -dist/jiangtun-$(VERSION)-dol-xiao-rp2040.uf2: .pio/build/dol-xiao-rp2040/firmware.uf2 dist - $(CP) $(call FIXPATH,$<) $(call FIXPATH,$@) - -all: dist/jiangtun-$(VERSION)-pico.uf2 dist/jiangtun-$(VERSION)-dol-pico.uf2 dist/jiangtun-$(VERSION)-xiao-rp2040.uf2 dist/jiangtun-$(VERSION)-dol-xiao-rp2040.uf2 - -clean: - $(RM) $(call FIXPATH,dist/*) - $(RM) $(call FIXPATH,.pio/build/*) \ No newline at end of file diff --git a/README.md b/README.md index 44ed5b6..9081a06 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,18 @@ # Jiangtun (江豚) -GC automation alternative firmware for Raspberry Pi Pico. +GameCube automation alternative firmware for RP2040. - [NX Macro Controller](https://blog.bzl-web.com/entry/2020/01/20/165719) - [Poke-Controller Modified](https://github.com/Moi-poke/Poke-Controller-Modified) -- [ORCA GC Controller](https://github.com/yatsuna827/Orca-GC-Controller) (experimental) +- [ORCA GC Controller](https://github.com/yatsuna827/Orca-GC-Controller) -Use GameCube: `GPIO5`, Servo: `GPIO6`. ([WHALE](https://github.com/mizuyoukanao/Bluewhale) compatible) +## Pin assignment + +| Pico | XIAO RP2040 | Function | +| :---: | :---------: | :----------------: | +| 7 | D5 | GameCube DATA | +| 0 | D6 | Servo | +| 3 | D10 | Reset (Active Low) | ## Button mapping @@ -18,14 +24,14 @@ Use GameCube: `GPIO5`, Servo: `GPIO6`. ([WHALE](https://github.com/mizuyoukanao/ | X | X | | L | L | | R | R | -| ZL | (none) | +| ZL | | | ZR | Z | -| - | (none) | +| - | | | + | Start | -| L Click | (none) | -| R Click | (none) | +| L Click | | +| R Click | | | Home | Reset | -| Capture | (none) | +| Capture | | ## Development diff --git a/lib/jiangtun-core/library.properties b/lib/jiangtun-core/library.properties index 2ef39ff..0dcd2db 100644 --- a/lib/jiangtun-core/library.properties +++ b/lib/jiangtun-core/library.properties @@ -1,5 +1,5 @@ name=jiangtun-core -version=1.0.0 +version=0.1.0 author=Koutaro Mukai maintainer=Koutaro Mukai sentence=The core library of Jiangtun.