summaryrefslogtreecommitdiffstats
path: root/Readme.txt
diff options
context:
space:
mode:
authorcpldcpu <cpldcpu@gmail.com>2013-12-15 08:16:50 +0100
committercpldcpu <cpldcpu@gmail.com>2013-12-15 08:16:50 +0100
commit04e4a5220debe366b96e08f5bbaaa5ea9a02523e (patch)
tree212a288d8b928297c6cc8775a1437fa511e644cc /Readme.txt
parentae9be0730b3bbb9ae0f1ef80abc372e4f604d143 (diff)
downloadmicronucleus-04e4a5220debe366b96e08f5bbaaa5ea9a02523e.tar.gz
micronucleus-04e4a5220debe366b96e08f5bbaaa5ea9a02523e.tar.bz2
micronucleus-04e4a5220debe366b96e08f5bbaaa5ea9a02523e.zip
markdown breaks everything! changed back to txt
Diffstat (limited to 'Readme.txt')
-rw-r--r--Readme.txt41
1 files changed, 41 insertions, 0 deletions
diff --git a/Readme.txt b/Readme.txt
new file mode 100644
index 0000000..051e54c
--- /dev/null
+++ b/Readme.txt
@@ -0,0 +1,41 @@
+
+Micronucleus
+=============
+Micronucleus is a bootloader designed for AVR tiny 85 chips with a minimal usb interface, cross platform libusb-based program upload tool, and a strong emphasis on bootloader compactness. The project aims to release a 2.0kb usb bootloader, and has reached this goal with the latest release. By using the tinyvector mechanism designed by Embedded Creations in their USBaspLoader-tiny85 project, combined with the simplicity of Objective Development's bootloadHID and a unique bare bones usb protocol, Micronucleus is the smallest usb bootloader available for tiny85 at the time of writing.
+
+Micronucleus adds a small amount of delay to the Pin Change interrupt in user applications, but this latency is low enough to not interfere with V-USB applications. Once bootloaded, an ISP or HVSP programmer can disable the reset pin, offering an extra pin for GPIO and ADC use! After disabling the reset pin functionality, of course you will no longer be able to use ISP programmers with the chip, but that's okay because we made a neat 'upgrade' program. The Upgrade program takes a compiled bootloader hex file and packs it in to an AVR program. You upload the 'upgrade' program via an existing micronucleus installation, any other bootloader, or via ISP or HVSP programmer, and once uploaded the upgrade program runs and writes over the bootloader and then installs a trampoline over it's own interrupt vector table, then reboots, launching the new bootloader. In this way users can change their bootloader to have bugfixes or different configurations like the 'jumper' versions without needing any programming tools.
+
+tiny85 does not offer any hardware bootloading support, and does not protect the bootloader from being accidentally overwritten by a misbehaving app. We recommend great caution if using flash self programming inside an uploaded program due to the potential of bricking.
+
+Micronucleus is now widely installed on over 40,000 Digispark devices from Digistump - a tiny unofficial arduino device, so you can be confident that micronucleus will be well supported in the future. Micronucleus is now also the recommended bootloader for Ihsan Kehribar's wonderful LittleWire devices, and can be successfully installed on to existing LittleWire's by uploading the 'upgrade' program via the old serial bootloader, then uploading the littlewire firmware via the micronucleus command line upload tool.
+
+Changes
+=======
+
+This is release 1.10. Please use this at your own risk. The last official release for the DigiSpark is v1.06, which can be found here: https://github.com/micronucleus/micronucleus/tree/v1.06
+
+Changes compared to v1.06:
+ • Major size optimization and code reorganization.
+ • The size was reduced to 1878 bytes, allowing 256 bytes more user space.
+ • The bootloader will disconnect from USB on exit.
+
+See release notes (/firmware/releases/release notes.txt) for details.
+
+@cpldcpu - Dec 15th, 2013
+
+----------------------------------------------------------------------------------
+==================================================================================
+!!%$!^%%$!#%$@#!%$@!$#@!%$#@%!#@%$!@$%#@!$%%!$#^&%$!%(*$!^%#!$@!#%$*^%!!&^%!%@$#!^
+@#$%^&*%#$%^#($)#*&($^#^*%&%%&@$*#($^&^*@$#&%^*%&($^&#^*%&$(^^%@$&^*#%@%&$^#*%^*%&
+&$%#$&^&$%@&#$*^*##*$##^$&#^%$^&*$&^&^%$#^%$&*$&#^%$*^$#^&%$*%#^$&^*%$#^$*^$$&*%#$
+==================================================================================
+----------------------------------------------------------------------------------
+
+Special Thanks:
+ • Objective Development's great V-USB bitbanging usb driver
+ • Embedded Creations' pioneering and inspiring USBaspLoader-tiny85
+ • Digistump for motivation and contributing the VID/PID pair
+ • Ihsan Kehribar for the command line C-based upload tool
+
+This project is released under the GPLv2 license. Code uploaded via the bootloader is not subject to any license issues.
+