Create README.md

Author: SimoSbara

README.md

@@ -0,0 +1,32 @@
+# wii-raytracing
+
+## Description
+
+This is a fast raytracing implementation on the Nintendo Wii using SIMD instruction provided by [libogc](https://github.com/devkitPro/libogc/tree/master). 
+
+It is an improved version of the [PlayStation 1 project](https://github.com/SimoSbara/ps1-raytracing).
+
+![](https://github.com/SimoSbara/wii-raytracing/blob/main/wii-raytracing.gif)
+
+I used [devkitPro](https://devkitpro.org/wiki/Getting_Started) for creating this project.
+
+### Testing on Emulator
+This project is tested on [Dolphin Emulator](dolphin-emu.org) Nintendo GameCube/Wii emulator.
+
+## Testing on Console
+
+If you want to test it on the real console, you need to:
+* get a SD card formatted in FAT32
+* install Homebrew Channel on the Wii following this [guide](https://wiibrew.org/wiki/Homebrew_Channel)
+* create a new folder called ```raytracing``` in ```SD root/apps/```
+* Download the latest [release](https://github.com/SimoSbara/wii-raytracing/releases) and put it on ```SD root/apps/raytracing```, **the name must be ```boot.dol```**
+
+## Development
+This project is currently in development on Ubuntu (using WSL), Windows is not tested.
+
+Steps for setting up environment:
+* follow this [guide](https://devkitpro.org/wiki/Getting_Started) for installing devkitPro and install the Wii Dev kit
+* execute ```source /etc/profile.d/devkit-env.sh``` to export devkit environment variables
+* clone the repository ```https://github.com/SimoSbara/wii-raytracing.git```
+
+Now you can build the project with ```make```, the binary is wii-raytracing.dol