diff --git a/Readme.txt b/README.md similarity index 90% rename from Readme.txt rename to README.md index b0782b6..2fc1628 100644 --- a/Readme.txt +++ b/README.md @@ -1,5 +1,15 @@ - +Table of Contents: =================================== +* [Installing Device Drivers](#INSTALLING-DEVICE-DRIVERS) + * [Easy Rippings](#EASY-RIPPINGS) +* [Running the Host Application](#RUNNING-THE-HOST-APPLICATION) +* [Updating Device Firmware](#UPDATING-DEVICE-FIRMWARE) + * [STM32 ARM based device versions "INLretro" V2.0 and later](#STM32-ARM-BASED-DEVICE-VERSIONS-"INLRETRO"-v2.0-AND-LATER) + * [AVR based devices versions "KAZZO" V1.4 and eariler](#AVR-based-devices-versions-"KAZZO"-V1.4-and-eariler) +* [Software & Firmware Building](#SOFTWARE-&-FIRMWARE-BUILDING) + * [Linux/Mac](#Linux/Mac) + * [Windows](#Windows) + INSTALLING DEVICE DRIVERS: =================================== @@ -20,9 +30,13 @@ If it worked properly you'll get a "install successful" page, click FINISH. In windows you should be able to see "INLretro-prog" listed in "devices and printers" from the control panel. +Easy Rippings +----------------------------------- +If you're only looking to rip your own carts, you can stop here and look at the [EasyRipping](./docs/EasyRippingGuide.md) guide. + +If you recently bought your INL-Retro, you shouldn't have to update firmware, but below are steps to update the firmware when future versions are released. If you have an older version, it's recommended you update the firmware first. -=================================== RUNNING THE HOST APPLICATION: =================================== @@ -50,14 +64,13 @@ USB connector on the INLretro programmer/dumper to reset the device, and try aga -=================================== UPDATING DEVICE FIRMWARE =================================== - ----------------------------------------------------------- STM32 ARM based device versions "INLretro" V2.0 and later ----------------------------------------------------------- +----------------------------------- + + If you purchased your device in 2018 or later you have this version This includes devices aquired with NESmaker kits. @@ -291,10 +304,9 @@ LINUX DFU-UTIL STEPS: sudo dfu-util -d 0483:* -a 0 -D INLretro6_PCBv2_0_FWv2_03_01.dfu - ----------------------------------------------------------- AVR based devices versions "KAZZO" V1.4 and eariler ----------------------------------------------------------- +----------------------------------- + If you purchased your device in 2017 or earlier you have this version This should also apply if you made your own kazzo based on the open source design. Although I can't assure this software works with @@ -384,14 +396,12 @@ and the device should be running the latest firmware ready to use the latest sof -=================================== SOFTWARE & FIRMWARE BUILDING =================================== Some build instructions follow, but they shouldn't be needed if you're running the released firmware on Windows. -=================== Linux/Mac =================== @@ -451,37 +461,38 @@ STM32 FIRMWARE: Need arm-none-eabi-gcc -=================== Windows =================== HOST APPLICATION: + Install minGW: - download: http://www.mingw.org/wiki/Getting_Started - launch: Installation manager default settings - select: mingw32-base - (primary need is gcc) - select: msys-base - (primary need is make, basic unix commands are nice to have) - optional: msys-openssh - (helpful if using gitlab to pull updates) - lua for host app dev - minGW utilities can be easily added or removed at any time with minGW installation manager. - Add C:\MinGW\bin & C:\MinGW\msys\1.0\bin to your PC's enviroment PATH variable - -control panel search: "edit system environment variables - -System properties window, Advanced tab, click Environment Variables... - -System Variables pane: Select and edit "PATH" - -Add new entries below assuming you used default location for minGW - C:\MinGW\bin - C:\MinGW\msys\1.0\bin - -I had troubles once with cp (copy) commands in Makefile + +* download: http://www.mingw.org/wiki/Getting_Started +* launch: Installation manager default settings +* select: mingw32-base + * (primary need is gcc) +* select: msys-base + * (primary need is make, basic unix commands are nice to have) +* optional: msys-openssh + * (helpful if using gitlab to pull updates) + * lua for host app dev +* minGW utilities can be easily added or removed at any time with minGW installation manager. +* Add C:\MinGW\bin & C:\MinGW\msys\1.0\bin to your PC's enviroment PATH variable + * -control panel search: "edit system environment variables + * -System properties window, Advanced tab, click Environment Variables... + * -System Variables pane: Select and edit "PATH" + * -Add new entries below assuming you used default location for minGW + * C:\MinGW\bin + * C:\MinGW\msys\1.0\bin + * -I had troubles once with cp (copy) commands in Makefile causing a crash, even though the commands works outside of make. Bumping the mingw path variables to the top of all my path variables corrected this issue. So that might help if you have similar issues... Now host app can be built from windows command prompt command make when in host directory --go to host --make all +* go to host +* make all If you want to build your own AVR FIRMWARE: Download and Install WinAVR diff --git a/docs/EasyRippingGuide.md b/docs/EasyRippingGuide.md new file mode 100644 index 0000000..bc3b72d --- /dev/null +++ b/docs/EasyRippingGuide.md @@ -0,0 +1 @@ +UNDER CONSTRUCTION \ No newline at end of file