condone small cleanup; add README

StringJan · Apr 9, 2024 · b7baaf8 · b7baaf8
1 parent b9d6bfd
commit b7baaf8
Show file tree

Hide file tree

Showing 4 changed files with 24 additions and 30 deletions.
diff --git a/ClientA.py b/ClientA.py
diff --git a/ClientB.py b/ClientB.py
diff --git a/README.md b/README.md
@@ -0,0 +1,24 @@
+# 3DS vJoy Controller
+This project allows anybody with one (or more) 3DS and vJoy to use their device(s) as a singular, coherent controller
+# Requirements
+- Nintendo 3DS
+  - with this spicy firmware Nintendo loves
+- [vJoy](https://github.com/shauleiz/vJoy)
+- Python
+  - `pyvjoy`
+## Build
+- [devkitARM](https://devkitpro.org/wiki/Getting_Started)
+# Getting the 3DS application
+## Universal Updater
+> [!NOTE]  
+> The app is being submited to Universal DB to be available in the Universal Updater directly
+
+## Release
+Go over to the releases and download the binary
+## Build
+`cd 3ds && make`
+# Usage
+1. Install the `.3dsx` app to your 3DS devices
+2. Start the server using `python3 server.py`
+3. Start the application on your 3DS devices
+4. Enter the IP of the server
diff --git a/ST.py → server.py b/ST.py → server.py